Skip to content

Commit 2697220

Browse files
committed
chore: add release steps documentation
1 parent 873554e commit 2697220

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

RELEASE_STEPS.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Release steps
2+
3+
This crate is released infrequently so it is easy to forget things that need to be done with a new release.
4+
Here's a list.
5+
6+
1. Is the crate formatted correctly?
7+
2. Do the unit tests pass on all platforms? (CI runs to check this are fine)
8+
- Windows
9+
- Linux
10+
- macOS
11+
- WebAssembly targets
12+
3. Is clippy linter reporting any issues?
13+
4. Does the crate build with an MSRV compiler on all platforms?
14+
5. Bump the version number
15+
6. Make sure CHANGELOG.md is up to date
16+
7. Tag the latest commit to master with the version number, format x.y.z
17+
8. Generate a release on GitHub
18+
9. Make sure the crate doesn't have Windows-style newlines when publishing, Linux distro maintainers seem to care about this.
19+
10. cargo publish
20+

0 commit comments

Comments
 (0)