Last active
July 8, 2026 01:53
-
-
Save muhadmr/3fe1431076d9946f4183b82887763c9b to your computer and use it in GitHub Desktop.
A command file for use with AI coding harness, to automate creation of structured changelog entries.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | |
| description: Append release notes to RELEASE_NOTE.md from staged/unstaged changes | |
| release-note is a custom Kilo CLI command that automates the creation of structured changelog entries. | |
| It scans the working directory for staged and unstaged changes (git diff --name-only HEAD), presents a summary of modified files, | |
| then interactively prompts for a version number, a descriptive heading, and one-line summaries for each change group. | |
| It maps each change to the relevant files and appends the entry — version, heading, numbered descriptions, | |
| and file paths — directly under the # CHANGELOG header in RELEASE_NOTE.md, with the newest entry always at the top. | |
| This ensures every release is consistently documented without manual formatting. | |
| sample usage : /release-note | |
| --- | |
| First, get the list of changed files: | |
| Run: `git diff --name-only HEAD` (for unstaged + staged). Also run `git status --short` for context. | |
| Present the user with a summary of what files have changed, then ask: | |
| 1. Version number (e.g. v1.1.2) | |
| 2. Brief heading describing the change group (e.g. "Booking - Bug Fix") | |
| 3. For each distinct change, ask: | |
| - A one-line description of what was done | |
| - Which of the changed files are relevant (the user can say "all" or pick specific files) | |
| Then append to RELEASE_NOTE.md directly under `# CHANGELOG` using this format: | |
| ``` | |
| ## {version} | |
| ### {heading} | |
| 1) {description} | |
| - Files affected: | |
| - {file path} | |
| - {file path} | |
| ``` | |
| Important: | |
| - Use forward slashes in file paths | |
| - Keep descriptions concise | |
| - Group related changes under the same heading | |
| - Only ask user for version/description — don't guess | |
| - Append after the `# CHANGELOG` line (i.e. as the newest entry at top) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment