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 update checker workflow [skip changelog] #10002

Merged
merged 3 commits into from
Jul 6, 2023

Conversation

galargh
Copy link
Contributor

@galargh galargh commented Jun 28, 2023

Related to ipfs/boxo#398

This PR adds a CI workflow which checks whether the PR contains docs/changelogs/ modifications.

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

The check succeeds if docs/changelogs/ was modified and fails otherwise.

Tested in galargh/.github#40


If we ever decide to use this beyond kubo/boxo, we should consider turning this into a reusable workflow.

@galargh galargh requested review from lidel and hacdias June 28, 2023 09:11
@galargh galargh requested a review from a team as a code owner June 28, 2023 09:11
Copy link
Member

@hacdias hacdias left a comment

Choose a reason for hiding this comment

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

I think this is a good option to ensure we always update the changelog, and are otherwise deliberate when not to.

@galargh galargh merged commit c293d62 into master Jul 6, 2023
15 checks passed
@BigLep BigLep mentioned this pull request Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants