Skip to content

Mention herald changelog management in RELEASE.md - #6651

Open
carbolymer wants to merge 1 commit into
sl/release-processfrom
mgalazyn/doc/update-release.md
Open

Mention herald changelog management in RELEASE.md#6651
carbolymer wants to merge 1 commit into
sl/release-processfrom
mgalazyn/doc/update-release.md

Conversation

@carbolymer

@carbolymer carbolymer commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Description

Stacked on #6585.

Documents herald changelog management in RELEASE.md.
A new "Herald-managed packages" subsection under Versioning explains how to compile changelogs with herald batch, that herald performs the actual version bump in the cabal file, and that the version has to be passed explicitly when the cabal version was already bumped by hand.
The release-notes step now points herald-managed packages at that subsection.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • roundtrip tests
    • integration tests
      See Running tests for more details
  • Any changes are noted in the CHANGELOG.md for affected package
    • cardano-node-chairman, cardano-submit-api and cardano-testnet instead need a
      changelog fragment in <package>/.changes/, because their CHANGELOG.md is generated
      from fragments at release time. Copy _TEMPLATE.yml from that directory, or run
      nix run github:input-output-hk/cardano-dev#herald -- new
  • The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-9.6 and ghc-9.12
  • Self-reviewed the diff

Note on CI

If your PR is from a fork, the necessary CI jobs won't trigger automatically for security reasons.
You will need to get someone with write privileges. Please contact IOG node developers to do this
for you.

@carbolymer
carbolymer changed the base branch from master to sl/release-process August 18, 2026 20:41
@carbolymer carbolymer self-assigned this Aug 18, 2026
@carbolymer carbolymer changed the title Mgalazyn/doc/update release.md Mention herald changelog management in RELEASE.md Aug 18, 2026
@carbolymer
carbolymer marked this pull request as ready for review August 18, 2026 20:54
@carbolymer
carbolymer requested a review from a team as a code owner August 18, 2026 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants