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 [email protected]

* fix(docs): release notes template typo

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 <tag of last release> --no-prefix --output <location to output patch txt file> -- */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
 

RELEASE-TEMPLATE.md

@@ -0,0 +1,29 @@
+## Build information
+
+Built using `rustc <rust version> (<commit hash<date>)`
+
+## 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`...

agents/kathy/CHANGELOG.md

@@ -2,14 +2,16 @@
 
 ### Unreleased
 
-- make *Settings::new async for optionally fetching config from a remote url
+### [email protected]
+
+- 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

agents/kathy/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "kathy"
-version = "1.0.0"
+version = "1.1.0"
 authors = ["James Prestwich <[email protected]>", "Luke Tchang <[email protected]>"]
 edition = "2021"
 description = "Nomad kathy agent"

agents/processor/CHANGELOG.md

@@ -2,7 +2,9 @@
 
 ### Unreleased
 
-- make *Settings::new async for optionally fetching config from a remote url
+### [email protected]
+
+- 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

agents/processor/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "processor"
-version = "1.0.0"
+version = "1.1.0"
 authors = ["Luke Tchang <[email protected]>", "James Prestwich <[email protected]>"]
 edition = "2021"
 description = "Nomad processor agent"

agents/relayer/CHANGELOG.md

@@ -2,14 +2,16 @@
 
 ### Unreleased
 
-- make *Settings::new async for optionally fetching config from a remote url
+### [email protected]
+
+- 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

agents/relayer/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "relayer"
-version = "1.0.0"
+version = "1.1.0"
 authors = ["Luke Tchang <[email protected]>", "James Prestwich <[email protected]>"]
 edition = "2021"
 description = "Nomad relayer agent"

agents/updater/CHANGELOG.md

@@ -2,13 +2,15 @@
 
 ### Unreleased
 
-- make *Settings::new async for optionally fetching config from a remote url
+### [email protected]
+
+- 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

agents/updater/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "updater"
-version = "1.0.0"
+version = "1.1.0"
 authors = ["James Prestwich <[email protected]>", "Luke Tchang <[email protected]>"]
 edition = "2021"
 description = "Nomad updater agent"

agents/watcher/CHANGELOG.md

@@ -2,13 +2,15 @@
 
 ### Unreleased
 
-- make *Settings::new async for optionally fetching config from a remote url
+### [email protected]
+
+- 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

agents/watcher/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "watcher"
-version = "1.0.0"
+version = "1.1.0"
 authors = ["Luke Tchang <[email protected]>", "James Prestwich <[email protected]>"]
 edition = "2021"
 description = "Nomad watcher agent"