ci: adds validation and message for changelog entry#7987
Open
baywet wants to merge 1 commit into
Open
Conversation
Signed-off-by: Vincent Biret <vibiret@microsoft.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a GitHub Actions workflow to automatically detect whether a PR introduces a new CHANGELOG.md entry under ## [Unreleased] and, if missing, posts a guidance comment to the PR. This improves contributor experience and helps keep release notes consistently updated.
Changes:
- Adds a PowerShell helper script to extract and compare
## [Unreleased]bullet entries between base and head changelog versions. - Introduces a
pull_request_targetworkflow that fetches base/headCHANGELOG.mdvia the GitHub API, runs the script, and comments when no new entry is found. - Updates
CONTRIBUTING.mdto clarify where to place changelog entries.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| scripts/check-changelog-entry.ps1 | Implements parsing/comparison logic for ## [Unreleased] changelog entries. |
| CONTRIBUTING.md | Clarifies changelog entry placement under ## [Unreleased] (### Added / ### Changed). |
| .github/workflows/changelog-entry.yml | Adds CI workflow to check for a new changelog entry and comment when missing. |
| $baseEntries = @(Get-UnreleasedEntries -changelogPath $baseChangelogPath) | ||
| $headEntries = @(Get-UnreleasedEntries -changelogPath $headChangelogPath) | ||
|
|
||
| return $headEntries.Count -gt $baseEntries.Count |
Code Coverage OverviewLanguages: C# C# / code-coverage/dotnetThe overall coverage in commit ace3fea in the Show a code coverage summary of the most covered files.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Vincent Biret vibiret@microsoft.com