Skip to content

Enhance changelog verifier script #13072

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.

Sign up for GitHub

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

Closed
kotwanikunal wants to merge 1 commit into from
Closed

Enhance changelog verifier script #13072

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions .github/workflows/changelog_verifier.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: "Changelog Verifier"
on:
pull_request:
types: [opened, edited, review_requested, synchronize, reopened, ready_for_review, labeled, unlabeled]
types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]

jobs:
# Enforces the update of a changelog file on every pull request
Expand All @@ -13,7 +13,19 @@ jobs:
with:
token: ${{ secrets.GITHUB_TOKEN }}
ref: ${{ github.event.pull_request.head.sha }}

- uses: dangoslen/changelog-enforcer@v3
id: verify-changelog-3x
with:
skipLabels: "autocut, skip-changelog"
changeLogPath: 'CHANGELOG-3.0.md'
Copy link
Copy Markdown
Contributor

@reta reta Apr 4, 2024

Choose a reason for hiding this comment

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

@kotwanikunal curious if we should be using CHANGELOG-3.x.md since it will be moving target essentially (like CHANGELOG-2.x.md which would correspond to 2.14.0 as of today)

Copy link
Copy Markdown
Member Author

@kotwanikunal kotwanikunal Apr 4, 2024

Choose a reason for hiding this comment

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

Sounds like a discussion for the other PR. Let me move this commit onto that branch and we can finalize the file names/convention on that thread.

continue-on-error: true
- uses: dangoslen/changelog-enforcer@v3
id: verify-changelog-2x
with:
skipLabels: "autocut, skip-changelog"
changeLogPath: 'CHANGELOG-2.0.md'
continue-on-error: true
- run: |
if [[ ${{ steps.verify-changelog-3x.outcome }} == 'failure' && ${{ steps.verify-changelog-2x.outcome }} == 'failure']]; then
exit 1
fi