Skip to content

Conversation

@neilmayhew
Copy link
Contributor

@neilmayhew neilmayhew commented Sep 3, 2025

Description

  • Add a changelog linting step to CI
  • Fix linting errors in changelogs

Checklist

  • Commits in meaningful sequence and with useful messages.
  • Tests added or updated when needed.
  • CHANGELOG.md files updated for packages with externally visible changes.
    NOTE: New section is never added with the code changes. (See RELEASING.md).
  • Versions updated in .cabal and CHANGELOG.md files when necessary, according to the
    versioning process.
  • Version bounds in .cabal files updated when necessary.
    NOTE: If bounds change in a cabal file, that package itself must have a version increase. (See RELEASING.md).
  • Code formatted (use scripts/fourmolize.sh).
  • Cabal files formatted (use scripts/cabal-format.sh).
  • CDDL files are up to date (use scripts/gen-cddl.sh)
  • hie.yaml updated (use scripts/gen-hie.sh).
  • Self-reviewed the diff.

@neilmayhew neilmayhew force-pushed the nm/changelog-linting branch 2 times, most recently from f9451d1 to 4caa636 Compare September 3, 2025 04:11
Copy link
Contributor

@Soupstraw Soupstraw left a comment

Choose a reason for hiding this comment

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

Nice, I like it!

Copy link
Contributor

@Lucsanszky Lucsanszky left a comment

Choose a reason for hiding this comment

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

This is going to be great! I believe this will be very useful down the line when working on the release tool: #4583. My only request is to add the linting commits here: https://github.com/IntersectMBO/cardano-ledger/blob/master/.git-blame-ignore-revs

Copy link
Collaborator

@lehins lehins left a comment

Choose a reason for hiding this comment

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

I love it! ❤️

@neilmayhew neilmayhew force-pushed the nm/changelog-linting branch 5 times, most recently from 8fb70c5 to ee72220 Compare September 4, 2025 17:27
@neilmayhew neilmayhew marked this pull request as ready for review September 4, 2025 21:13
@neilmayhew neilmayhew requested a review from a team as a code owner September 4, 2025 21:13
@neilmayhew neilmayhew enabled auto-merge September 4, 2025 21:14
Copy link
Collaborator

@lehins lehins left a comment

Choose a reason for hiding this comment

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

Aside from the source where the tool is coming from I am totally in favor of these changes!
Thank you!

@neilmayhew neilmayhew requested a review from lehins September 5, 2025 04:53
Copy link
Contributor

@Lucsanszky Lucsanszky left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

Copy link
Collaborator

@lehins lehins left a comment

Choose a reason for hiding this comment

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

🎊

@neilmayhew neilmayhew merged commit faa7a9d into master Sep 9, 2025
127 checks passed
@neilmayhew neilmayhew deleted the nm/changelog-linting branch September 9, 2025 19:03
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.

6 participants