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

Add action for checking changelog updates #1358

Merged
merged 7 commits into from
Nov 13, 2024
Merged

Add action for checking changelog updates #1358

merged 7 commits into from
Nov 13, 2024

Conversation

f0uriest
Copy link
Member

@f0uriest f0uriest commented Nov 12, 2024

Adds a GH action that ensures CHANGELOG.md is updated with each PR, unless the PR is labelled skip_changelog

Resolves #1340

@f0uriest f0uriest added the skip_changelog No need to update changelog on this PR label Nov 12, 2024
@f0uriest f0uriest added skip_changelog No need to update changelog on this PR and removed skip_changelog No need to update changelog on this PR labels Nov 12, 2024
@f0uriest f0uriest requested review from a team, rahulgaur104, ddudt, dpanici, kianorr, sinaatalay, unalmis and YigitElma and removed request for a team November 12, 2024 17:08
@f0uriest f0uriest added the easy Short and simple to code or review label Nov 12, 2024
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- if: ${{ !contains(github.event.pull_request.labels.*.name, 'skip_changelog') }}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Adding filter for changed files could save time here

- name: Filter changes
        id: changes
        uses: dorny/paths-filter@v3
        with:
          filters: |
            has_changes:
              - 'desc/**'

For the changelog, we don't want to include the changes in other folders anyway.

Copy link
Member Author

Choose a reason for hiding this comment

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

this whole action takes a few seconds so don't think its really worth it.

Copy link
Collaborator

Choose a reason for hiding this comment

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

By time, I mean adding the flag. If this test runs for every PR and fails, then that small red cross could be annoying :)

@f0uriest f0uriest merged commit a880816 into master Nov 13, 2024
23 checks passed
@f0uriest f0uriest deleted the rc/changelog branch November 13, 2024 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy Short and simple to code or review skip_changelog No need to update changelog on this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add GH action that checks if the changelog has been updated on each PR
3 participants