docs: document vociferate release migration

This commit is contained in:
Micheal Wilkinson
2026-03-21 11:09:40 +00:00
parent 0112d9a0a6
commit ca3215f2c4

View File

@@ -13,6 +13,7 @@ A `### Breaking` section is used in addition to Keep a Changelog's standard sect
### Added ### Added
- CI validation now runs `gosec` and `govulncheck` security scanning on push and pull request workflows.
- `rc` command: executes all executable scripts inside a castle's `.homesick.d/` directory in sorted order, with the castle root as the working directory. stdout/stderr from each script is forwarded to the caller. - `rc` command: executes all executable scripts inside a castle's `.homesick.d/` directory in sorted order, with the castle root as the working directory. stdout/stderr from each script is forwarded to the caller.
- `rc` command: when a `.homesickrc` file exists and no `parity.rb` wrapper is present in `.homesick.d/`, a Ruby wrapper script (`parity.rb`) is generated automatically to preserve backwards compatibility. An existing `parity.rb` is never overwritten. - `rc` command: when a `.homesickrc` file exists and no `parity.rb` wrapper is present in `.homesick.d/`, a Ruby wrapper script (`parity.rb`) is generated automatically to preserve backwards compatibility. An existing `parity.rb` is never overwritten.
- `exec` command: runs a shell command inside the target castle root directory. - `exec` command: runs a shell command inside the target castle root directory.
@@ -33,6 +34,7 @@ A `### Breaking` section is used in addition to Keep a Changelog's standard sect
### Changed ### Changed
- Release automation now uses `aether/vociferate` `prepare` and `publish` actions (pinned to `v1.0.0`) instead of repository-local releaseprep wrappers.
- CLI argument parsing migrated to Kong. - CLI argument parsing migrated to Kong.
- Git operations for clone and track migrated to `go-git`. - Git operations for clone and track migrated to `go-git`.
- Build and behavior workflows now produce and run the `gosick` binary name. - Build and behavior workflows now produce and run the `gosick` binary name.
@@ -54,6 +56,7 @@ A `### Breaking` section is used in addition to Keep a Changelog's standard sect
### Removed ### Removed
- Legacy `script/prepare-release.sh` releaseprep wrapper and its dedicated script test.
- Legacy Ruby implementation and Ruby toolchain. - Legacy Ruby implementation and Ruby toolchain.
- Legacy in-repository `releaseprep` package and command implementation, now superseded by the standalone `vociferate` tool. - Legacy in-repository `releaseprep` package and command implementation, now superseded by the standalone `vociferate` tool.