Instruction file imported from stiwicourage/KeepAChangelog (
.github/instructions/release-policy.instructions.md). Copyright stays with the author.
KeepAChangelog release policy
Scope
Use this file when changing versioning, changelog handling, package metadata, publish workflows, or release automation.
Versioning rules
- Follow Semantic Versioning intent.
- Treat
CHANGELOG.mdas the exhaustive release history. - Treat
RELEASE_NOTE.mdas the interface-focused summary for public cmdlet, CLI, configuration, and migration changes. - Keep
## [Unreleased]valid and readable. - Use only the official Keep a Changelog section types in both files:
Added,Changed,Deprecated,Removed,Fixed, andSecurity. - Do not add custom section headings such as
Documentation; place documentation-related release notes under the official type that best matches the real change. - If
RELEASE_NOTE.mdhas no public API or workflow changes under## [Unreleased], keep the exact placeholder under### Added:No public API or workflow changes in this release. Internal maintenance only. - If
RELEASE_NOTE.mdhas real release-note entries, do not keep that placeholder. - Do not add compare-link footer URLs to
RELEASE_NOTE.md. - For unreleased feature iterations, update the existing
Addedentry instead of adding an internal-historyChangedentry.
Workflow rules
Publish.ymlowns the release/publish flow.mainhandles stable release commit/tag flow and preparesdevelopfor the next prerelease.develophandles prerelease publish and next-prerelease bump flow.- Do not change branch mutation behavior, tag creation, or publish steps without reading release workflow files, when present and the related custom actions first.
Documentation rules
- Review
README.md,CONTRIBUTING.md,CHANGELOG.md, andRELEASE_NOTE.mdfor workflow or release changes. - Update command help in
docs/KeepAChangelog/en-US/when public command behavior changes. - Update project docs only when end-user behavior or examples changed.
- Use
.github/pull_request_template.mdas the authoritative structure when preparing a release summary for review.
Agent safety rules
- Do not publish, create tags, or push release commits unless the task explicitly requires it.
- Do not assume a preview flow should move
latest; check the current package and release tests first. - Do not change release defaults without corresponding tests and changelog entries.
Verification
- Validate the touched release or versioning path with targeted tests.
- Run the repository quality loop when one exists after code changes.
- Re-read
.github/pull_request_template.mdbefore preparing release-related summaries.