From 0b965f900cdb23cbb1324685834d8fa1184d0a7b Mon Sep 17 00:00:00 2001 From: Andrew Gallant Date: Fri, 29 May 2020 09:21:19 -0400 Subject: [PATCH] doc: small release checklist updates In particular, explicitly note when to update the CHANGELOG. Also, tweak the ripgrep introductory message. --- RELEASE-CHECKLIST.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/RELEASE-CHECKLIST.md b/RELEASE-CHECKLIST.md index 29b45cd2..045fa449 100644 --- a/RELEASE-CHECKLIST.md +++ b/RELEASE-CHECKLIST.md @@ -19,6 +19,7 @@ Release Checklist * crates/printer * crates/grep (bump minimal versions as necessary) * crates/core (do **not** bump version, but update dependencies as needed) +* Update the CHANGELOG as appropriate. * Edit the `Cargo.toml` to set the new ripgrep version. Run `cargo update -p ripgrep` so that the `Cargo.lock` is updated. Commit the changes and create a new signed tag. Alternatively, use @@ -29,8 +30,8 @@ Release Checklist Include this blurb describing what ripgrep is: > In case you haven't heard of it before, ripgrep is a line-oriented search > tool that recursively searches your current directory for a regex pattern. - > By default, ripgrep will respect your `.gitignore` and automatically skip - > hidden files/directories and binary files. + > By default, ripgrep will respect your gitignore rules and automatically + > skip hidden files/directories and binary files. * Run `ci/build-deb` locally and manually upload the deb package to the release. * Run `cargo publish`.