Skip to content

Commit f7a70a5

Browse files
committed
Document the release process
1 parent 6ecfdc2 commit f7a70a5

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,13 @@ It contains two main modes:
6666
`decodeme` holds the decoding definitions of the profiling event data from `measureme`.
6767

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

0 commit comments

Comments
 (0)