Skip to content

docs: clarify changelog generator scripts - #298

Merged
Isthimius merged 3 commits into
masterfrom
20260901_changelog_readme
Sep 1, 2026
Merged

docs: clarify changelog generator scripts#298
Isthimius merged 3 commits into
masterfrom
20260901_changelog_readme

Conversation

@Isthimius

Copy link
Copy Markdown
Owner

Summary

  • move the project generator prerequisites, parameters, and examples back under its own section
  • document the root generator's actual behavior, parameters, examples, and existing-file requirement
  • identify Changelog-ProjectGroups.ps1 as a shared support file rather than a third generator
  • clarify that changelog and config paths resolve from the repository root

Validation

  • verified every documented parameter against the PowerShell parser output for both generators and release.ps1
  • ran git diff --check

Copilot AI lite review requested due to automatic review settings September 1, 2026 21:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 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.ps1 documentation to reflect its actual behavior (including -SectionOnly) and the “existing root changelog required” constraint.
  • Clarifies that ChangelogPath / CliffConfigPath parameters resolve relative to the repository root (including for release.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.

Comment thread Tooling/scripts/README.md Outdated
Isthimius and others added 2 commits September 1, 2026 17:09
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@Isthimius
Isthimius merged commit 09cd223 into master Sep 1, 2026
8 checks passed
@Isthimius
Isthimius deleted the 20260901_changelog_readme branch September 1, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants