diff options
| author | Nick Gerace <nickagerace@gmail.com> | 2023-07-07 11:06:31 -0400 |
|---|---|---|
| committer | Nick Gerace <nickagerace@gmail.com> | 2023-07-07 11:06:31 -0400 |
| commit | 76d9d6d0c728052af68a3354b4fae4d5a91c751b (patch) | |
| tree | 6cbff722fe2d3d57702610ad51a360e98ebd865e /docs | |
| parent | 5441679c46216b335ac11488eb789e39246dd45a (diff) | |
| download | gfold-76d9d6d0c728052af68a3354b4fae4d5a91c751b.zip | |
Add libgfold CHANGELOG and release process
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/RELEASE.md | 41 |
1 files changed, 36 insertions, 5 deletions
diff --git a/docs/RELEASE.md b/docs/RELEASE.md index 8b36897..a396ff1 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -2,14 +2,14 @@ This document contains all information related to release. -## Checklist +## Checklist (gfold) -This checklist details the `gfold` release process. +This checklist details the [**gfold**](../README.md) release process. Steps should be executed in sequential order. - [ ] Checkout and rebase `main` to its latest commit, then checkout a new branch -- [ ] Change the `version` field in [`Cargo.toml`](../crates/gfold/Cargo.toml) to the new tag -- [ ] **Full Releases Only**: change the version in `CHANGELOG.md` and uncomment the following line: `<!--The latest version contains all changes.-->` +- [ ] Change the `version` field in [`Cargo.toml`](../bin/gfold/Cargo.toml) to the new tag +- [ ] **Full Releases Only**: change the version in [`CHANGELOG.md`](../CHANGELOG.md) and uncomment the following line: `<!--The latest version contains all changes.-->` - [ ] Verify that everything looks/works as expected: ```shell @@ -50,7 +50,38 @@ cargo install --locked --version <tag> gfold ``` - [ ] Verify that the [GitHub release](https://github.com/nickgerace/gfold/releases) on the repository's releases page looks correct -- [ ] **Full Releases Only**: Update the formula for the [Hombrew tap](https://github.com/nickgerace/homebrew-nickgerace) +- [ ] **Full Releases Only**: Update the formula for the [Homebrew tap](https://github.com/nickgerace/homebrew-nickgerace) + +## Checklist (libgfold) + +This checklist details the [**libgfold**](../lib/libgfold/README.md) release process. +Steps should be executed in sequential order. + +- [ ] Checkout and rebase `main` to its latest commit and checkout a new branch +- [ ] Change the `version` field in [`Cargo.toml`](../lib/libgfold/Cargo.toml) to the new tag +- [ ] **Full Releases Only**: change the version in [`CHANGELOG.md`](../lib/libgfold/CHANGELOG.md) and uncomment the following line: `<!--The latest version contains all changes.-->` +- [ ] Verify that everything looks/works as expected: + +```shell +cargo xtask ci +``` + +- [ ] Create and _do not merge_ a commit with the following message: `Update libgfold to <tag>` +- [ ] Test and verify the publishing workflow: + +```shell +cargo publish --dry-run -p libgfold +``` + +- [ ] Merge the preparation commit into `main` +- [ ] Publish the crate: + +```shell +cargo publish -p libgfold +``` + +- [ ] Verify that the [crate](https://crates.io/crates/libgfol) on `crates.io` looks correct +- [ ] Ensure that the [docs](https://docs.rs/libgfold/latest/libgfold/) on `docs.rs` look correct ## Versioning Scheme |