Skip to content

Mention herald changelog management in RELEASE.md #6651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
carbolymer wants to merge 1 commit into from
+8 −1
Open

Mention herald changelog management in RELEASE.md #6651

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Expand Down Expand Up @@ -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 <package>` (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
Expand Down
Loading