Skip to content

Bump herald-release to 0.0.3.1 - #1367

Merged
carbolymer merged 1 commit into
masterfrom
mgalazyn/feature/bump-herald-release-0.0.3.1
Oct 7, 2026
Merged

carbolymer merged 1 commit into
masterfrom
mgalazyn/feature/bump-herald-release-0.0.3.1

Conversation

@carbolymer

@carbolymer carbolymer commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

Context

Bumps the herald-release action used in .github/workflows/release.yml from herald-release-0.0.3.0 to herald-release-0.0.3.1.

The new herald-release fixes the CHaP submission snippet that gets embedded in release PR bodies.
The snippet resolved a release tag to a commit hash with git ls-remote <repo> refs/tags/<tag>.
For signed or annotated tags, that command returns the tag object's own hash rather than the commit hash, so the hash passed on to CHaP's add-from-github.sh was never a commit.
The snippet now resolves the tag to the commit it points to, for both annotated and lightweight tags.

References:

No changelog fragment is needed for this PR.
Herald's --diff check only requires a fragment for a project when a changed file sits under that project's directory, and .github/ sits outside all of cardano-api's projects.

How to trust this PR

The only change is the pinned action version in .github/workflows/release.yml.
The fix was verified in the cardano-dev repository itself; the next cardano-api release run that produces a CHaP submission snippet exercises the corrected tag resolution.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff
  • Changelog fragment added in .changes/

@carbolymer carbolymer self-assigned this Oct 6, 2026
@carbolymer
carbolymer marked this pull request as ready for review October 6, 2026 17:48
@carbolymer
carbolymer requested review from a team, Jimbo4350 and palas as code owners October 6, 2026 17:48
Copilot AI balanced review requested due to automatic review settings October 6, 2026 17:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

The required changelog fragment is missing.

Review effort: Balanced
Findings: 1 Low severity

Open (1)
What changed in this PR

Updates the release workflow to use herald-release 0.0.3.1, fixing CHaP commit resolution for annotated tags.

Changes:

  • Bumps the pinned action from 0.0.3.0 to 0.0.3.1.
File Description
.github/​workflows/​release.yml Updates the Herald release action version.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

accept-flake-config = true

- uses: input-output-hk/cardano-dev/actions/herald-release@herald-release-0.0.3.0
- uses: input-output-hk/cardano-dev/actions/herald-release@herald-release-0.0.3.1

@palas palas left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, probably for the best. I've seen tags end up as broken links in the CHaP webpage. 👍

@carbolymer
carbolymer enabled auto-merge October 7, 2026 06:12
@carbolymer
carbolymer disabled auto-merge October 7, 2026 06:46
@carbolymer
carbolymer merged commit 425f122 into master Oct 7, 2026
29 checks passed
@carbolymer
carbolymer deleted the mgalazyn/feature/bump-herald-release-0.0.3.1 branch October 7, 2026 06:46
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.

3 participants