Add workflow for changelog verification #4085
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| name: "Changelog Verifier" | ||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled] | ||
|
|
||
| jobs: | ||
| # Enforces the update of a changelog file on every pull request | ||
| verify-changelog: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3.0.2 | ||
kotwanikunal marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| ref: ${{ github.event.pull_request.head.ref }} | ||
|
|
||
| - uses: dangoslen/dependabot-changelog-helper@v1 | ||
|
|
||
| - uses: stefanzweifel/git-auto-commit-action@v4.14.1 | ||
| with: | ||
| commit_message: "Update changelog" | ||
|
|
||
| - uses: dangoslen/changelog-enforcer@v3 | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # CHANGELOG | ||
| Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) | ||
|
|
||
| ## [ UNRELEASED ] | ||
kotwanikunal marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ### Added | ||
| - Github workflow for changelog verification | ||
|
There was a problem hiding this comment. Let's start with a format that includes a link to the PR? There was a problem hiding this comment. The only concern I have with that is it will become a 2 step process -
Let me check if there is an automated mechanism/property within the used GHA to achieve this. There was a problem hiding this comment. Working backwards from the end goal of users being able to find what the change was I think that's an acceptable overhead. |
||
|
|
||
| ### Changed | ||
|
|
||
| ### Deprecated | ||
|
|
||
| ### Removed | ||
|
|
||
| ### Fixed | ||
|
|
||
| ### Security | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not all PRs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The default mechanism for
pull_requesttrigger is as follows:By default, a workflow only runs when a pull_request event's activity type is opened, synchronize, or reopened.I have updated the GHA config to reflect all the types I found could match our case.