-
Notifications
You must be signed in to change notification settings - Fork 10
feat: GHA workflow to enforce changelog updates #197
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
base: main
Are you sure you want to change the base?
Conversation
feat: GHA workflow to enforce changelog updates
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.
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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
fix: update regex pattern to avoid false positives
…into phi/changelog-check
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 |
Add GitHub Actions workflow to enforce changelog updates: