Skip to content

Commit 871d168

Browse files
committed
Update contrib/release/README for Rust releases
- Add a step for manually updating the version in Cargo.toml. - Use `git archive` for source distributions instead of former Python/setuptools mechanism. - Use dotted triples (X.Y.Z) instead of dotted doubles (X.Y) since Cargo requires triples.
1 parent bb75272 commit 871d168

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

contrib/release/README

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,19 @@ StGit Release Checklist
1515
- Change "[Unreleased]" to reflect new release version and date.
1616
- Commit updated CHANGELOG.md
1717

18-
2. Create new tag
18+
2. Update version in Cargo.toml
1919

20-
- `git tag --sign -m 'Release vX.Y' vX.Y`
20+
- Update the version field: `version = "X.Y.Z"`
2121

22-
3. Check source distribution
22+
3. Create new tag
2323

24-
- Create source distribution with `make dist`.
25-
- Find source dist file in `dist/`.
26-
- Make sure correct version is in dist filename.
27-
- Spot-check dist contents for any extra or missing files.
24+
- `git tag --sign -m 'Release vX.Y.Z' vX.Y.Z`
2825

29-
4. Run pkgtest.py
26+
4. Make source archive
3027

31-
- Use options to test supported Python versions
32-
- Spot-check output
28+
- `git archive --format=tar.gz --prefix=stgit-X.Y.Z/ -o stgit-X.Y.Z.tar.gz vX.Y.Z`
29+
- Note the trailing slash in the `--prefix` value.
30+
- This archive will be uploaded in step 7.
3331

3432
5. Update stacked-git.github.io
3533

@@ -45,10 +43,10 @@ StGit Release Checklist
4543

4644
7. Create GitHub release
4745

48-
- Use "Stacked Git X.Y" for release title.
46+
- Use "Stacked Git X.Y.Z" for release title.
4947
- Write a sentence or two description of release.
5048
- Paste this versions changes from CHANGELOG.md.
51-
- Upload source dist file (`stgit-X.Y.tar.gz`).
49+
- Upload source archive file (`stgit-X.Y.Z.tar.gz`) from step 4.
5250

5351
8. Send notifications
5452

0 commit comments

Comments
 (0)