docs: clarify changelog generator scripts - #298
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The updated root-changelog “What it does” list overstates that the file header is preserved “exactly,” which doesn’t match the script’s whitespace normalization behavior.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates Tooling/scripts/README.md to more accurately document the repository’s changelog generation scripts (project vs root), the shared Changelog-ProjectGroups.ps1 support file, and how relative paths are resolved from the repository root.
Changes:
- Reorganizes the changelog generator documentation so prerequisites/parameters/examples are under the correct script sections.
- Expands
Generate-Root-Changelog.ps1documentation to reflect its actual behavior (including-SectionOnly) and the “existing root changelog required” constraint. - Clarifies that
ChangelogPath/CliffConfigPathparameters resolve relative to the repository root (including forrelease.ps1).
File summaries
| File | Description |
|---|---|
| Tooling/scripts/README.md | Clarifies and restructures documentation for changelog/release PowerShell scripts and shared support definitions. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Summary
Changelog-ProjectGroups.ps1as a shared support file rather than a third generatorValidation
release.ps1git diff --check