From 57b1d036cbeef4c5442c3b0920bdf33ce9b351b2 Mon Sep 17 00:00:00 2001 From: Luke Tchang Date: Thu, 21 Jul 2022 14:02:12 -0400 Subject: [PATCH] release: bump changelogs/versions for new release + add release notes template (#221) * feat(docs): add release template and include in release process docs * chore(versions): bump changelogs and versions for agents@1.1.0 * fix(docs): release notes template typo --- Cargo.lock | 10 +++++----- README.md | 5 ++--- RELEASE-TEMPLATE.md | 29 +++++++++++++++++++++++++++++ agents/kathy/CHANGELOG.md | 6 ++++-- agents/kathy/Cargo.toml | 2 +- agents/processor/CHANGELOG.md | 6 ++++-- agents/processor/Cargo.toml | 2 +- agents/relayer/CHANGELOG.md | 6 ++++-- agents/relayer/Cargo.toml | 2 +- agents/updater/CHANGELOG.md | 6 ++++-- agents/updater/Cargo.toml | 2 +- agents/watcher/CHANGELOG.md | 6 ++++-- agents/watcher/Cargo.toml | 2 +- 13 files changed, 61 insertions(+), 23 deletions(-) create mode 100644 RELEASE-TEMPLATE.md diff --git a/Cargo.lock b/Cargo.lock index 6ff7aa42..2ee3c154 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2004,7 +2004,7 @@ dependencies = [ [[package]] name = "kathy" -version = "1.0.0" +version = "1.1.0" dependencies = [ "affix", "async-trait", @@ -3233,7 +3233,7 @@ dependencies = [ [[package]] name = "processor" -version = "1.0.0" +version = "1.1.0" dependencies = [ "affix", "async-trait", @@ -3428,7 +3428,7 @@ checksum = "49b3de9ec5dc0a3417da371aab17d729997c15010e7fd24ff707773a33bddb64" [[package]] name = "relayer" -version = "1.0.0" +version = "1.1.0" dependencies = [ "affix", "async-trait", @@ -4801,7 +4801,7 @@ checksum = "a156c684c91ea7d62626509bce3cb4e1d9ed5c4d978f7b4352658f96a4c26b4a" [[package]] name = "updater" -version = "1.0.0" +version = "1.1.0" dependencies = [ "affix", "async-trait", @@ -5031,7 +5031,7 @@ dependencies = [ [[package]] name = "watcher" -version = "1.0.0" +version = "1.1.0" dependencies = [ "affix", "async-trait", diff --git a/README.md b/README.md index 1627dbf1..5b6c60cb 100644 --- a/README.md +++ b/README.md @@ -147,7 +147,7 @@ Releases are managed on GitHub [here](https://github.com/nomad-xyz/rust/releases ### Aggregating the Changelog - Output a patch file by running `git diff --no-prefix --output -- */CHANGELOG.md */*/CHANGELOG.md` -- Organize and format patch file into a changelog (for tag message and release notes) +- Organize and format patch file into release notes (see [template](./RELEASE-TEMPLATE.md)) ### Bumping Versions @@ -162,8 +162,7 @@ Releases are managed on GitHub [here](https://github.com/nomad-xyz/rust/releases - Push tags by running `git push --tags` - Visit the [releases page](https://github.com/nomad-xyz/rust/releases) for the `rust` repo - Draft a new release using the newly published tag -- Include your changelog as the release notes -- Publish release +- Publish release with your included release notes ## Advanced Usage diff --git a/RELEASE-TEMPLATE.md b/RELEASE-TEMPLATE.md new file mode 100644 index 00000000..de687655 --- /dev/null +++ b/RELEASE-TEMPLATE.md @@ -0,0 +1,29 @@ +## Build information + +Built using `rustc ()` + +## Upgrade Instructions + +If the agent configuration interface or DB schema has changed such that it is not backwards compatible, please enumerate instructions for upgrading agent (e.g. change environment variables, delete agent DB, etc). Otherwise, please explicitly document that the release is backwards compatible and no additional steps are required. + +## New Features + +Enumerate all features added to each crate, listing them for each crate separately. + +Example: + +- `nomad-core` + - Features in `nomad-core`... +- `nomad-base` + - Features in `nomad-base`... + +## Fixes + +Enumerate all fixes/patches added to each crate, listing them for each crate separately. + +Example: + +- `nomad-core` + - Fixes in `nomad-core`... +- `nomad-base` + - Fixes in `nomad-base`... diff --git a/agents/kathy/CHANGELOG.md b/agents/kathy/CHANGELOG.md index ea3c5a96..3a618498 100644 --- a/agents/kathy/CHANGELOG.md +++ b/agents/kathy/CHANGELOG.md @@ -2,14 +2,16 @@ ### Unreleased -- make *Settings::new async for optionally fetching config from a remote url +### agents@1.1.0 + +- make \*Settings::new async for optionally fetching config from a remote url - add test for remote config fetch - add bootup-only tracing subscriber - add environment variable overrides for agent configuration - add tests for agent environment variable overrides - remove `enabled` flag from agents project-wide -### 1.0.0 +### agents@1.0.0 - bumps version for first release - adds a changelog diff --git a/agents/kathy/Cargo.toml b/agents/kathy/Cargo.toml index 0e107d75..2260399a 100644 --- a/agents/kathy/Cargo.toml +++ b/agents/kathy/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "kathy" -version = "1.0.0" +version = "1.1.0" authors = ["James Prestwich ", "Luke Tchang "] edition = "2021" description = "Nomad kathy agent" diff --git a/agents/processor/CHANGELOG.md b/agents/processor/CHANGELOG.md index e0953e54..f23075e3 100644 --- a/agents/processor/CHANGELOG.md +++ b/agents/processor/CHANGELOG.md @@ -2,7 +2,9 @@ ### Unreleased -- make *Settings::new async for optionally fetching config from a remote url +### agents@1.1.0 + +- make \*Settings::new async for optionally fetching config from a remote url - add bootup-only tracing subscriber - bug: add check for empty intersection of specified and subsidized - refactor: processor now uses global AWS client when proof pushing is enabled @@ -13,7 +15,7 @@ - add tests for agent environment variable overrides - remove `enabled` flag from agents project-wide -### 1.0.0 +### agents@1.0.0 - bumps version for first release - adds a changelog diff --git a/agents/processor/Cargo.toml b/agents/processor/Cargo.toml index 28d5b5b3..9e50355e 100644 --- a/agents/processor/Cargo.toml +++ b/agents/processor/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "processor" -version = "1.0.0" +version = "1.1.0" authors = ["Luke Tchang ", "James Prestwich "] edition = "2021" description = "Nomad processor agent" diff --git a/agents/relayer/CHANGELOG.md b/agents/relayer/CHANGELOG.md index bc28b55f..37086489 100644 --- a/agents/relayer/CHANGELOG.md +++ b/agents/relayer/CHANGELOG.md @@ -2,14 +2,16 @@ ### Unreleased -- make *Settings::new async for optionally fetching config from a remote url +### agents@1.1.0 + +- make \*Settings::new async for optionally fetching config from a remote url - relayer checks replica updater addresses match, errors channel if otherwise - add bootup-only tracing subscriber - add environment variable overrides for agent configuration - add tests for agent environment variable overrides - remove `enabled` flag from agents project-wide -### 1.0.0 +### agents@1.0.0 - bumps version for first release - adds a changelog diff --git a/agents/relayer/Cargo.toml b/agents/relayer/Cargo.toml index 32ee4bb3..57e6d4db 100644 --- a/agents/relayer/Cargo.toml +++ b/agents/relayer/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "relayer" -version = "1.0.0" +version = "1.1.0" authors = ["Luke Tchang ", "James Prestwich "] edition = "2021" description = "Nomad relayer agent" diff --git a/agents/updater/CHANGELOG.md b/agents/updater/CHANGELOG.md index 1a5c72e0..e24ca464 100644 --- a/agents/updater/CHANGELOG.md +++ b/agents/updater/CHANGELOG.md @@ -2,13 +2,15 @@ ### Unreleased -- make *Settings::new async for optionally fetching config from a remote url +### agents@1.1.0 + +- make \*Settings::new async for optionally fetching config from a remote url - add bootup-only tracing subscriber - add environment variable overrides for agent configuration - add tests for agent environment variable overrides - remove `enabled` flag from agents project-wide -### 1.0.0 +### agents@1.0.0 - bumps version for first release - adds a changelog diff --git a/agents/updater/Cargo.toml b/agents/updater/Cargo.toml index c04d7477..f438cb05 100644 --- a/agents/updater/Cargo.toml +++ b/agents/updater/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "updater" -version = "1.0.0" +version = "1.1.0" authors = ["James Prestwich ", "Luke Tchang "] edition = "2021" description = "Nomad updater agent" diff --git a/agents/watcher/CHANGELOG.md b/agents/watcher/CHANGELOG.md index 1a5c72e0..e24ca464 100644 --- a/agents/watcher/CHANGELOG.md +++ b/agents/watcher/CHANGELOG.md @@ -2,13 +2,15 @@ ### Unreleased -- make *Settings::new async for optionally fetching config from a remote url +### agents@1.1.0 + +- make \*Settings::new async for optionally fetching config from a remote url - add bootup-only tracing subscriber - add environment variable overrides for agent configuration - add tests for agent environment variable overrides - remove `enabled` flag from agents project-wide -### 1.0.0 +### agents@1.0.0 - bumps version for first release - adds a changelog diff --git a/agents/watcher/Cargo.toml b/agents/watcher/Cargo.toml index a69087ca..16388e57 100644 --- a/agents/watcher/Cargo.toml +++ b/agents/watcher/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "watcher" -version = "1.0.0" +version = "1.1.0" authors = ["Luke Tchang ", "James Prestwich "] edition = "2021" description = "Nomad watcher agent"