Skip to content

Document the release process #247

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 1 commit into from
Jul 8, 2025
Merged

Document the release process #247

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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,13 @@ It contains two main modes:
`decodeme` holds the decoding definitions of the profiling event data from `measureme`.

[Learn more](./decodeme/README.md)

## How to make a release

1) Bump version of `measureme`, `decodeme` and `analyzeme` crates in the root `Cargo.toml` file
- Update both `workspace.version` and `workspace.dependencies.[analyzeme/decodeme/measureme].version`
2) Update changelog with latest changes
- You can use `https://github.com/rust-lang/measureme/compare/<last-released-tag>...master` to see what has changed since the last released tag
3) Merge a PR with the changes above (e.g. https://github.com/rust-lang/measureme/pull/240)
4) Create a git tag based on the merged PR, and push it
5) Create a GitHub release manually based on that tag, CI will then take care of publishing the crates