Add libgfold CHANGELOG and release process

Signed-off-by: Nick Gerace <nickagerace@gmail.com>
nickgerace · Jul 7, 2023 · 76d9d6d · 76d9d6d
1 parent 5441679
commit 76d9d6d
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 5 deletions.
diff --git 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
 

diff --git a/lib/libgfold/CHANGELOG.md b/lib/libgfold/CHANGELOG.md
@@ -0,0 +1,26 @@
+# Changelog ([libgfold](./README.md))
+
+- All notable changes to this project will be documented in this file
+- All changes are from [@nickgerace](https://github.com/nickgerace) unless otherwise specified
+- The format was inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+- This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
+
+## Unreleased
+
+<!-- The latest version contains all changes. -->
+
+### Changed
+
+- Bump deps
+
+## 0.1.1 - 2023-06-26
+
+### Added
+
+- Add a `README` for the crate
+
+## 0.1.0 - 2023-06-26
+
+### Added
+
+- Add initial contents