Skip to content

Conversation

rjan90
Copy link
Contributor

@rjan90 rjan90 commented Sep 16, 2025

Add GitHub Actions workflow to enforce changelog updates:

  • Add changelog.yml workflow that checks for CHANGELOG.md updates on PRs
  • Support multiple skip options: label, PR title, or in PR description.
  • Add changelog guidelines to README Contributing section

feat: GHA workflow to enforce changelog updates
@FilOzzy FilOzzy added this to FS Sep 16, 2025
@github-project-automation github-project-automation bot moved this to 📌 Triage in FS Sep 16, 2025
@rjan90 rjan90 moved this from 📌 Triage to 🔎 Awaiting review in FS Sep 16, 2025
@rjan90 rjan90 moved this to 🔎 Awaiting review in PDP Sep 16, 2025
@rjan90 rjan90 requested review from rvagg and jennijuju September 16, 2025 06:18
@rjan90
Copy link
Contributor Author

rjan90 commented Sep 16, 2025

Confirming that the check fails when there is no label on it:

Screenshot 2025-09-16 at 08 18 44

@rjan90 rjan90 added the skip/changelog This change does not require CHANGELOG.md update label Sep 16, 2025
@rjan90
Copy link
Contributor Author

rjan90 commented Sep 16, 2025

Once the label is added, the test passes:

Screenshot 2025-09-16 at 08 19 31

@rjan90 rjan90 requested a review from Copilot September 16, 2025 06:20
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Adds a GitHub Actions workflow to enforce changelog updates on pull requests to maintain better project documentation and change tracking.

  • Creates a new workflow file that validates CHANGELOG.md updates on PRs
  • Provides multiple skip mechanisms (label, PR title, or description patterns)
  • Updates contributing guidelines in README with changelog requirements

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
.github/workflows/changelog.yml New workflow to check for CHANGELOG.md updates with flexible skip options
README.md Adds changelog guidelines to contributing section and fixes license links

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

rjan90 and others added 3 commits September 16, 2025 08:24
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
fix: update regex pattern to avoid false positives
@rjan90 rjan90 marked this pull request as draft September 16, 2025 08:32
@rjan90
Copy link
Contributor Author

rjan90 commented Sep 16, 2025

We believe we can improve our habits around adding key items and breaking changes to the unreleased section of the changelog, and PR descriptions. I have therefore drafted this PR, and giving that approach a try for a while

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip/changelog This change does not require CHANGELOG.md update
Projects
Status: 🔎 Awaiting review
Status: 🔎 Awaiting review
Development

Successfully merging this pull request may close these issues.

1 participant