This directory contains changelog entry fragments that are compiled into CHANGELOG.md during releases.
- Copy
TEMPLATE.yamlto a new file (use.yamlor.ymlextension) - Name it using your PR number (e.g.,
1234.yaml) or a descriptive slug (e.g.,add-feature-name.yaml) - Fill in the required fields:
type: One of: Added, Changed, Developer Experience, Deprecated, Docs, Fixed, Removed, Securitydescription: Short description (start with past-tense verb, e.g., "Added...", "Fixed...")pr: PR numberlabels: Optional list:["high-risk"],["db-migration"], or both
Preview (dry run):
nox -s "changelog(dry)" -- --release 2.77.0Compile and create release section:
nox -s "changelog(write)" -- --release 2.77.0For patch releases (only specific PRs):
nox -s "changelog(write)" -- --release 2.76.2 --prs 1234,5678The script will:
- Compile fragments into a new version section
- Delete processed fragment files
- Update compare links in
CHANGELOG.md
Note: The write action always requires the --release VERSION flag.