Skip to content

Add post-release steps to release doc #154

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
archigup merged 1 commit into from
Aug 24, 2026
Merged

Add post-release steps to release doc #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 10 additions & 6 deletions docs/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,23 +41,27 @@ The html output will be in `build/cov-out`.
The following is the process for cutting a release of this repo. Use previous
releases as examples.

1. Ensure CI is green on main branch.
2. Ensure all new features have been added to all the bindings.
3. Make a release PR updating just the release notes and versions.
1. Ensure you have credentials to upload the crate to crates.io.
2. Ensure CI is green on main branch.
3. Ensure all new features have been added to all the bindings.
4. Make a release PR updating just the release notes and versions.
1. Add a new section to top of release notes with sections with lists of new
features and bug fixes customers should be made aware of. Skip mentioning
commits which don't have customer impact.
2. Update the version in `rust/Cargo.toml` and run cargo to update the
version in `rust/Cargo.lock` accordingly.
3. Use the format "Release vX.Y.Z" for the PR description and you can leave
PR body blank.
4. Merge the release PR when ready.
5. Tag the release with an annotated tag (`-a` flag to `git tag`).
5. Merge the release PR when ready.
6. Tag the release with an annotated tag (`-a` flag to `git tag`).
1. Run `git tag -a vX.Y.Z`
2. For the tag message, use "vX.Y.Z release" for the title, and copy the new
release notes section into the description. Remove the markdown markup
from the copied release notes (lists are fine). Note that this should be
79 col wrapped to match git conventions. See previous tags for examples.
3. Push the tag after verifying it is an annotated tag.
6. Make a Github release from the tag. Use same title and body as the tag
7. Make a Github release from the tag. Use same title and body as the tag
message. Note that Github does not handle line wrapping, so unwrap the lines.
8. Publish the crate to crates.io using `nix run .#publish-rust-crate`. You must
use that command or else the uploaded crate will not work.
9. Make PR in aws-greengrass-lite to update the SDK version.
Loading