Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: add changelog check workflow #12191

Merged
merged 3 commits into from
Jul 9, 2024
Merged

ci: add changelog check workflow #12191

merged 3 commits into from
Jul 9, 2024

Conversation

laurentsenta
Copy link
Contributor

Related Issues

Closes #12069

Proposed Changes

This PR adds a CI workflow that checks whether the PR contains CHANGELOG.md modifications.

The check can be skipped by adding [skip changelog] to the PR title or labeling the PR with skip/changelog. These instructions are included in the PR template and the workflow failure message.

The checks succeed if CHANGELOG.md is modified and fail otherwise.

Checklist

Before you mark the PR ready for review, please make sure that:

  • Commits have a clear commit message.
  • PR title is in the form of of <PR type>: <area>: <change being made>
    • example: fix: mempool: Introduce a cache for valid signatures
    • PR type: fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test
    • area, e.g. api, chain, state, mempool, multisig, networking, paych, proving, sealing, wallet, deps
  • If the PR affects users (e.g., new feature, bug fix, system requirements change), update the CHANGELOG.md and add details to the UNRELEASED section.
  • New features have usage guidelines and / or documentation updates in
  • Tests exist for new functionality or change in behavior
  • CI is green

@laurentsenta laurentsenta marked this pull request as draft July 5, 2024 10:33
@laurentsenta laurentsenta requested a review from galargh July 5, 2024 10:34
@galargh galargh added the skip/changelog This change does not require CHANGELOG.md update label Jul 5, 2024
@galargh galargh marked this pull request as ready for review July 5, 2024 13:40
@galargh galargh requested review from BigLep, rvagg and rjan90 July 5, 2024 13:41
Copy link
Contributor

@rjan90 rjan90 left a comment

Choose a reason for hiding this comment

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

Awesome!

Co-authored-by: Rod Vagg <rod@vagg.org>
Copy link
Member

@rvagg rvagg left a comment

Choose a reason for hiding this comment

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

I can see this is going to be quite annoying, at least for a while

@laurentsenta laurentsenta merged commit 1fb8efe into master Jul 9, 2024
78 checks passed
@laurentsenta laurentsenta deleted the ipdx-changelog-check branch July 9, 2024 07:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip/changelog This change does not require CHANGELOG.md update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DX Streamline] Build CHANGELOG incrementally
4 participants