Throw warning if CHANGELOG.md file has not been modified
#1400
Conversation
.github/workflows/changelog.yml
Outdated
| if git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep -q "CHANGELOG.md"; then | ||
| echo "CHANGELOG.md has been modified. Good job!" | ||
| else | ||
| echo "::error::CHANGELOG.md has not been modified. Please update the changelog." |
There was a problem hiding this comment.
I think a warning is fine, no? Sometimes, we have small PRs (hotfixes or whatnot - such as this one 🙂) that really don't need a changelog entry. It would be nice to not have to merge it with a red CI
There was a problem hiding this comment.
Indeed, let me see if I can make it a little bit less aggressive.
There was a problem hiding this comment.
There was a problem hiding this comment.
Yeah, I think that's too subtle, and my understanding is that there is no way to show a warning in the PR itself (only failure and success). If so, I think we should show a failure and then the admins can merge the PR anyway if in fact the PR doesn't need the changelog updated.
There was a problem hiding this comment.
Indeed, I was hoping for some "yellow CI" of some sort, but if this is the only way to do warnings, let's do errors instead
phklive
force-pushed
the
phklive-changelog-warning
branch
from
24f3358
to
44cf789
Compare
phklive
force-pushed
the
phklive-changelog-warning
branch
from
831e0b4
to
5830a13
Compare
In this PR I propose to add a warning if the
CHANGELOG.mdfile has not been modified.