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 #398

Merged
merged 4 commits into from
Jul 6, 2023
Merged

ci: add changelog update checker workflow #398

merged 4 commits into from
Jul 6, 2023

Conversation

galargh
Copy link
Contributor

@galargh galargh commented Jun 27, 2023

Resolves #267

This PR adds a CI workflow which checks whether the PR contains CHANGELOG.md 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 checks succeeds if CHANGELOG.md was modified and fails otherwise.

Tested in galargh/.github#40

@galargh galargh requested a review from a team as a code owner June 27, 2023 16:44
@galargh galargh requested review from BigLep and hacdias June 27, 2023 16:45
@codecov
Copy link

codecov bot commented Jun 27, 2023

Codecov Report

Merging #398 (f479b6c) into main (cfcbdbc) will increase coverage by 0.04%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #398      +/-   ##
==========================================
+ Coverage   49.49%   49.53%   +0.04%     
==========================================
  Files         248      248              
  Lines       29838    29838              
==========================================
+ Hits        14769    14781      +12     
+ Misses      13640    13632       -8     
+ Partials     1429     1425       -4     

see 10 files with indirect coverage changes

@galargh galargh requested a review from lidel June 28, 2023 08:51
@hacdias
Copy link
Member

hacdias commented Jun 29, 2023

@galargh question: will we need to add [skip changelog] to release-related PRs?

@galargh
Copy link
Contributor Author

galargh commented Jun 30, 2023

@galargh question: will we need to add [skip changelog] to release-related PRs?

Good call! How about we trigger only on PRs that modify Go files (including go.mod/go.sum)? I think that should cover the cases where CHANGELOG update might be required.

@galargh galargh changed the title ci: add changelog update checker workflow [skip changelog] ci: add changelog update checker workflow Jun 30, 2023
@hacdias
Copy link
Member

hacdias commented Jun 30, 2023

@galargh that still worries me: what about a cherry-picked release like #401, and a merge back PR like #403?

@galargh
Copy link
Contributor Author

galargh commented Jun 30, 2023

#401 modifies Go files so the changelog workflow run would be triggered. It also modifies CHANGELOG.md so the workflow run would have passed.

#403 doesn't modify Go files so with the changes from 71cac87 the changelog workflow wouldn't run at all.

@hacdias
Copy link
Member

hacdias commented Jun 30, 2023

Okay, I think it sounds good. I'm happy to get this merged. We can always make any improvements if we find something.

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.

Enforce changelog updates in CI
2 participants