Switch to herald for releasing#1381
Merged
carbolymer merged 2 commits intoMay 20, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR migrates the repository’s changelog/release process to herald, replacing the previous PR-description-based changelog check with fragment-based validation and adding a manual release workflow.
Changes:
- Add
.herald.ymlto define change kinds and thecardano-cliproject metadata for herald. - Replace the existing “PR changelog” GitHub Action with a herald fragment validation workflow.
- Update the PR template and add a
.changes/_TEMPLATE.ymlto guide contributors toward fragment-based changelogs. - Add a new
workflow_dispatch-driven release workflow that invokesherald-release.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
.herald.yml |
Introduces herald configuration (kinds, bumps, project paths). |
.github/workflows/release.yml |
Adds a manual release workflow using herald-release. |
.github/workflows/check-pr-changelog.yml |
Replaces PR-description changelog checking with herald validation. |
.github/PULL_REQUEST_TEMPLATE.md |
Updates contributor guidance to require .changes/ fragments and how to create them. |
.changes/_TEMPLATE.yml |
Adds a fragment template for contributors (ignored by herald due to _ prefix). |
Comments suppressed due to low confidence (1)
.github/workflows/check-pr-changelog.yml:33
- The PR template/checklist says every PR needs a changelog fragment in
.changes/, but this required check currently runsherald-validatewithpr: false, so it won’t enforce that PRs actually add a fragment. Consider enabling PR-level validation (or adjusting the template text) so CI and contributor guidance don’t diverge.
# TODO: enable --pr check after backfilling existing PRs with fragments
- uses: input-output-hk/cardano-dev/actions/herald-validate@herald-validate-0.0.1.0
with:
pr: false
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
5849c5b to
9b2069f
Compare
9b2069f to
c73ab73
Compare
Jimbo4350
approved these changes
May 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changelog
Context
Switch to herald for releasing. This PR is a copy of changes from IntersectMBO/cardano-api#1164
Checklist