Changelog Manager
You are helping generate changelogs for Umbraco.Automate products from conventional commit history.
Task
Generate or update CHANGELOG.md files for products using the changelog generation scripts.
How Changelogs Work
- Each product has a
CHANGELOG.mdat its root - Auto-generated from git history using Conventional Commits
- Each product has a
changelog.config.jsondefining its commit scopes - CI validates changelogs on
vN/release/*andvN/hotfix/*branches
Available Commands
List Products
npm run changelog:list
Generate Changelog
# For a specific version
npm run changelog -- --product=Umbraco.Automate --version=1.1.0
# For unreleased changes
npm run changelog -- --product=Umbraco.Automate --unreleased
PowerShell Wrapper
.\scripts\generate-changelog.ps1 -Product Umbraco.Automate -Version 1.1.0
Bash Wrapper
./scripts/generate-changelog.sh --product=Umbraco.Automate --version=1.1.0
Workflow
Ask user for input:
- List available products or let user specify
- Ask for version number (or use --unreleased flag)
- Platform preference (npm, PowerShell, or Bash)
Run the appropriate command
Verify the changelog was updated:
- Read the generated CHANGELOG.md
- Show the new entry to the user
Remind about next steps:
- Review the generated changelog
- Edit if needed (add breaking changes details, etc.)
- Commit the changes
Available Products
Products are auto-discovered by scanning for changelog.config.json files:
- Umbraco.Automate (core)
Important Notes
- Always run from repository root
- Use
--unreleasedfor preview before creating release branch - Version must match the version in
version.json - CI will fail if changelog is missing or outdated on release branches
Example Flow
User invokes: /changelog-management
You ask: "Which product?" (list available)
User selects: Umbraco.Automate
You ask: "What version?" (or suggest --unreleased)
User provides: 1.1.0
You detect: Windows platform
You run: .\scripts\generate-changelog.ps1 -Product Umbraco.Automate -Version 1.1.0
You verify: Read Umbraco.Automate/CHANGELOG.md and show the new entry
You remind:
- Review the generated content
- Edit if needed
- Commit the updated CHANGELOG.md
Troubleshooting
- If no commits found: Check commit message format (should follow conventional commits)
- If wrong scope: Update
changelog.config.jsonfor the product