diff --git a/RELEASE.md b/RELEASE.md index 1f9e1d0dd64..dd2d4c2ef2f 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -60,7 +60,8 @@ This is the release process for node releases. 6. The community is notified of the release candidate and given time to provide feedback. 7. The Release Engineer creates a draft GitHub Release and asks dev leads to - fill in their changelog sections. + fill in their changelog sections; for herald-managed packages the + changelog section is compiled from fragments, see Versioning. 8. CPC, TSC, Release Engineer, and SRE Lead sign off → the release is published as a **GitHub pre-release**. 9. QA runs the final integration test suite (`cardano-node-tests`). @@ -184,6 +185,12 @@ Example: `10.2.1` was published as a GitHub pre-release for approximately one month before being promoted to a full release. The tag was always `10.2.1`; only the GitHub release type changed. +## Herald-managed packages + +`cardano-node-chairman`, `cardano-submit-api` and `cardano-testnet` manage changelogs with herald (see `.herald.yml`): each PR adds a fragment under the package's `.changes/` directory. +At release time, run `herald batch ` (available in the nix dev shell) to compile the changelog and bump the version in the cabal file. +It bumps relative to the current cabal version, so pass the version explicitly (`-v A.B.C.D`) if that was already bumped by hand. + # Collaboration Intersect runs a weekly **Release Office Hours** meeting that all team leads