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.

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

Jump to bottom

ci: add job to enforce updates to the changelog #483

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open

ci: add job to enforce updates to the changelog #483

wants to merge 4 commits into from

Conversation

ricomateo
Copy link
Contributor

@ricomateo ricomateo commented Jan 29, 2025 •
edited
Loading

Fixes #484

What Changed?

This PR introduces the following changes:

  • Adds a CI job that enforces the CHANGELOG.md file to be updated on every pull request.
    It is also required that the changes in the changelog include the pull request URL.
    Important: This check is skipped if the pull request includes the changelog-ignore label.
  • Adds a CHANGELOG.md skeleton file.

Reviewer Checklist

  • Code is well-documented
  • Code adheres to Go naming conventions
  • Code deprecates any old functionality before removing it

@ricomateo ricomateo added the changelog-ignore PR is allowed to skip the changelog check label Jan 29, 2025
@ricomateo ricomateo marked this pull request as ready for review January 29, 2025 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pablodeymo pablodeymo pablodeymo approved these changes

Assignees
No one assigned
Labels
changelog-ignore PR is allowed to skip the changelog check
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add workflow that enforces the update of the CHANGELOG.md file on every PR
2 participants
@ricomateo @pablodeymo