Skip to content

Document the release process #7419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 8, 2025
Merged

Document the release process #7419

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f2322a
Document the release process
sylvestre Mar 8, 2025
d871c07
doc: Update publish command in DEVELOPMENT.md
sylvestre Mar 8, 2025
e0caf0d
Mention that assets should be checked
sylvestre Mar 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,3 +337,13 @@ Otherwise please follow [this guide](https://learn.microsoft.com/en-us/windows/d
If you have used [Git for Windows](https://gitforwindows.org) to install `git` on you Windows system you might already have some GNU core utilities installed as part of "GNU Bash" included in Git for Windows package, but it is not a complete package. [This article](https://gist.github.com/evanwill/0207876c3243bbb6863e65ec5dc3f058) provides instruction on how to add more to it.

Alternatively you can install [Cygwin](https://www.cygwin.com) and/or use [WSL2](https://learn.microsoft.com/en-us/windows/wsl/compare-versions#whats-new-in-wsl-2) to get access to all GNU core utilities on Windows.

# Preparing a new release

1. Modify `util/update-version.sh` (FROM & TO) and run it
1. Submit a new PR with these changes and wait for it to be merged
1. Tag the new release `git tag -a X.Y.Z` and `git push --tags`
1. Once the CI is green, a new release will be automatically created in draft mode.
Reuse this release and make sure that assets have been added.
1. Write the release notes (it takes time) following previous examples
1. Run `util/publish.sh --do-it` to publish the new release to crates.io
Loading