Ensure Changelog is updated with every PR. #537
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jnsbck
force-pushed
the
check_changelog_updated
branch
2 times, most recently
from
c472b28 to
bae9622
Compare
|
regression tests failing can be ignored. Test workflow for changelog works correctly. |
|
Definitely a great idea to automate the check! Are you thinking to leave it to the discretion of the maintainer if it's appropriate to ignore the check? (e.g. a typo fix) |
|
Currently this would be the case, but I am also not so happy about the current implementation at the moment. I also thought about adding a separate workflow i.e. "chores" and incl. isort, black, license header and changelog in there. This would be much cleaner and easier to quickly check for the maintainer as well. |
jnsbck
force-pushed
the
check_changelog_updated
branch
from
c85c6c6 to
d7c4396
Compare
|
I did some refactoring:
The maintainer would now only need to check why chores fail, i.e. because of no updates to changelog. |
jnsbck
force-pushed
the
check_changelog_updated
branch
from
d7c4396 to
614ac2c
Compare
|
@michaeldeistler thoughts? |
michaeldeistler
approved these changes
Dec 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I also like the suggestion of @ntolley to make updating the changelog part of PRs. To avoid having to remind contributors on every PR this could be enforced via github actions. I wrote a little check to do this.
(Quick test: changelog not updated -> tests should fail)