Prompt file imported from stiwicourage/KeepAChangelog (
.github/prompts/prepare-release.prompt.md). Copyright stays with the author.
Prepare a KeepAChangelog release
Invoke with
@.github/prompts/prepare-release.prompt.md. Delegates to therelease-manageragent.
Prepare release-related changes in KeepAChangelog without publishing or tagging.
Required process
- Read
CHANGELOG.md,RELEASE_NOTE.md,project.json,README.md,CONTRIBUTING.md,.github/pull_request_template.md, and release workflow files, when present. - Inspect the touched versioning, package, publish, or release tests.
- Confirm whether the change affects stable releases, prereleases, or both.
- Update changelog, release notes, and contributor docs as needed.
- Use only the official Keep a Changelog section types in
CHANGELOG.mdandRELEASE_NOTE.md:Added,Changed,Deprecated,Removed,Fixed, andSecurity.- Do not create custom headings such as
Documentation; place documentation-related release notes under the official type that best matches the actual impact.
- Do not create custom headings such as
- Check whether
RELEASE_NOTE.mdneeds the placeholder rule under## [Unreleased]:- If there are no real public API or workflow changes, ensure
### Addedcontains exactlyNo public API or workflow changes in this release. Internal maintenance only. - If there are real release-note entries, remove that placeholder.
- If there are no real public API or workflow changes, ensure
- Keep
RELEASE_NOTE.mdfree of compare-link footer URLs. - Validate the relevant release or versioning path.
- Summarize the result using the exact structure from
.github/pull_request_template.md. - Make the summary concise, reviewer-focused, directly reusable, and compliant with the
markdown-authoringskill (.github/skills/markdown-authoring/SKILL.md) when the output is returned as Markdown.
Repository-specific reminders
- Do not publish packages.
- Do not create tags.
- Do not push release commits.
- Keep unreleased changelog entries aligned with the final intended behavior, not internal iteration history.
- Keep
CHANGELOG.mdexhaustive and keepRELEASE_NOTE.mdlimited to public interface, configuration, and migration changes. - Treat
.github/pull_request_template.mdas the source of truth for release-preparation summaries. - If the summary must be pasted as one Markdown block in the UI, it should follow the
markdown-authoringskill (.github/skills/markdown-authoring/SKILL.md).