Skip to content

chore: add changelog fragments#923

Merged
ovitrif merged 3 commits intomasterfrom
chore/add-changelog-fragments
Apr 30, 2026
Merged

chore: add changelog fragments#923
ovitrif merged 3 commits intomasterfrom
chore/add-changelog-fragments

Conversation

@piotr-iohk
Copy link
Copy Markdown
Collaborator

@piotr-iohk piotr-iohk commented Apr 30, 2026

Closes #921

Description

This PR:

  1. Adds changelog.d/next and changelog.d/hotfix fragment folders.
  2. Adds release tooling to collect fragments into CHANGELOG.md and preview pending fragments in the terminal.
  3. Updates agent, PR, and release guidance so normal PRs add fragments instead of editing CHANGELOG.md directly.

Preview

N/A

QA Notes

1. Collector no-op

  • Run scripts/collect-changelog.sh --target next with no fragments and confirm it exits cleanly.
  • Run scripts/collect-changelog.sh --target hotfix with no fragments and confirm it exits cleanly.

2. Preview pending fragments

  • Add a temporary valid fragment under changelog.d/next/.
  • Run scripts/preview-changelog.sh --target next and confirm it renders the entry grouped by category.
  • Remove the temporary fragment.

3. Release collection

  • Add a temporary valid fragment under changelog.d/next/.
  • Run scripts/collect-changelog.sh --target next and confirm it is inserted under ## [Unreleased] and the fragment is deleted.
  • Revert the temporary changelog change after testing.

Made with Cursor

@piotr-iohk piotr-iohk self-assigned this Apr 30, 2026
@claude

This comment has been minimized.

@piotr-iohk piotr-iohk requested review from jvsena42 and ovitrif April 30, 2026 14:45
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Apr 30, 2026

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@ovitrif ovitrif added this to the 2.3.0 milestone Apr 30, 2026
@ovitrif ovitrif enabled auto-merge April 30, 2026 15:30
Copy link
Copy Markdown
Collaborator

@ovitrif ovitrif left a comment

Choose a reason for hiding this comment

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

tAck

Besides the listed tests, I also tested some edge cases:

  • 🟢 collect changelog with multiple changelogs fragments and in multiple passes (run, then run again for new fragments)
  • 🟢 collect changelog with hotfix target and a test target
  • 🟢 collect changelog with multiline fragment text - it got normalised to 1-line, LGTM

@ovitrif ovitrif merged commit 17fed92 into master Apr 30, 2026
11 checks passed
@ovitrif ovitrif deleted the chore/add-changelog-fragments branch April 30, 2026 15:56
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.

Use changelog fragments to avoid PR conflicts

2 participants