2020-05-09 05:05:33 +02:00
|
|
|
Release Checklist
|
|
|
|
|
-----------------
|
|
|
|
|
* Run `cargo update` and review dependency updates. Commit updated
|
|
|
|
|
`Cargo.lock`.
|
2020-05-09 16:26:00 +02:00
|
|
|
* Run `cargo outdated` and review semver incompatible updates. Unless there is
|
|
|
|
|
a strong motivation otherwise, review and update every dependency.
|
2020-05-09 05:05:33 +02:00
|
|
|
* Review changes for every crate in `crates` since the last ripgrep release.
|
2020-05-09 16:59:22 +02:00
|
|
|
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)
|
2020-05-29 15:21:19 +02:00
|
|
|
* Update the CHANGELOG as appropriate.
|
2020-05-09 05:05:33 +02:00
|
|
|
* Edit the `Cargo.toml` to set the new ripgrep version. Run
|
|
|
|
|
`cargo update -p ripgrep` so that the `Cargo.lock` is updated. Commit the
|
2020-05-09 17:43:37 +02:00
|
|
|
changes and create a new signed tag. Alternatively, use
|
|
|
|
|
`cargo-up --no-push --no-release Cargo.toml {VERSION}` to automate this.
|
2020-05-09 05:05:33 +02:00
|
|
|
* 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.
|
|
|
|
|
* Copy the relevant section of the CHANGELOG to the tagged release notes.
|
2020-05-09 17:43:37 +02:00
|
|
|
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.
|
2020-05-29 15:21:19 +02:00
|
|
|
> By default, ripgrep will respect your gitignore rules and automatically
|
|
|
|
|
> skip hidden files/directories and binary files.
|
2020-05-09 05:05:33 +02:00
|
|
|
* Run `ci/build-deb` locally and manually upload the deb package to the
|
|
|
|
|
release.
|
|
|
|
|
* Run `cargo publish`.
|
2020-05-09 17:43:37 +02:00
|
|
|
* Run `ci/sha256-releases {VERSION} >> pkg/brew/ripgrep-bin.rb`. Then edit
|
|
|
|
|
`pkg/brew/ripgrep-bin.rb` to update the version number and sha256 hashes.
|
2020-05-09 05:05:33 +02:00
|
|
|
Remove extraneous stuff added by `ci/sha256-releases`. Commit changes.
|
2020-05-29 15:49:45 +02:00
|
|
|
* Add TBD section to the top of the CHANGELOG:
|
|
|
|
|
```
|
|
|
|
|
TBD
|
|
|
|
|
===
|
|
|
|
|
Unreleased changes. Release notes have not yet been written.
|
|
|
|
|
```
|
2020-05-09 17:43:37 +02:00
|
|
|
|
|
|
|
|
Note that
|
|
|
|
|
[`cargo-up` can be found in BurntSushi's dotfiles](https://github.com/BurntSushi/dotfiles/blob/master/bin/cargo-up).
|
