twin/ripgrep
1
0
Fork 0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-05-19 09:40:22 -07:00
Code Issues Packages Projects Releases Wiki Activity

doc: add more detail to release checklist

Browse Source 
Getting the crate order right is important, so document it.
This commit is contained in:
Andrew Gallant 2020-05-09 10:59:22 -04:00
parent 72807462e8
commit 4b8e1f030e
No known key found for this signature in database
GPG Key ID: B2E3A4923F8B0D44
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
RELEASE-CHECKLIST.md
View File

@ -5,10 +5,24 @@ Release Checklist
* Run `cargo outdated` and review semver incompatible updates. Unless there is * Run `cargo outdated` and review semver incompatible updates. Unless there is
a strong motivation otherwise, review and update every dependency. a strong motivation otherwise, review and update every dependency.
* Review changes for every crate in `crates` since the last ripgrep release. * Review changes for every crate in `crates` since the last ripgrep release.
If the set of changes is non-empty, issue a new release for that crate. If the set of changes is non-empty, issue a new release for that crate. Check
crates in the following order. After updating a crate, ensure minimal
versions are updated as appropriate in dependents. If an update is required,
run `cargo-up --no-push crates/{CRATE}/Cargo.toml`.
* crates/globset
* crates/ignore
* crates/cli
* crates/matcher
* crates/regex
* crates/pcre2
* crates/searcher
* crates/printer
* crates/grep (bump minimal versions as necessary)
* crates/core (do **not** bump version, but update dependencies as needed)
* Edit the `Cargo.toml` to set the new ripgrep version. Run * Edit the `Cargo.toml` to set the new ripgrep version. Run
`cargo update -p ripgrep` so that the `Cargo.lock` is updated. Commit the `cargo update -p ripgrep` so that the `Cargo.lock` is updated. Commit the
changes. changes. Alternatively, use
`cargo-up --no-push --no-release Cargo.toml {VERSION}`.
* Create a new signed tag for the ripgrep release. Push it to GitHub. * Create a new signed tag for the ripgrep release. Push it to GitHub.
* Wait for CI to finish creating the release. If the release build fails, then * Wait for CI to finish creating the release. If the release build fails, then
delete the tag from GitHub, make fixes, re-tag, delete the release and push. delete the tag from GitHub, make fixes, re-tag, delete the release and push.