Release Notes Generator
Visual Studio Code extension that prompts for release details and prepends a formatted entry to your release notes file.
Features
- Command Palette action
Release Notes: Generate (Cmd+Alt+R / Ctrl+Alt+R) collects version, release type, features, fixes, and breaking changes.
- Writes to
# Release Notes in the configured file, creating it if missing and inserting new entries at the top.
- Empty sections are skipped; if everything is empty, it records
_No user-visible changes listed._.
- Output file defaults to
RELEASE_NOTES.md at the workspace root, overridable via settings.
Usage
- Open a workspace folder.
- Run
Release Notes: Generate from the Command Palette or the keyboard shortcut.
- Fill in the prompts; multi-line inputs become bullet lists.
- The extension opens the release notes file with the new entry added above existing content.
# Release Notes
## v1.2.3 - 2024-11-07
**Type:** minor
### ✨ Features
- Example feature
### 🐛 Fixes
- Example fix
### ⚠️ Breaking Changes
- Example breaking change
If no features, fixes, or breaking changes are provided, the body becomes _No user-visible changes listed._.
Configuration
releaseNotesGenerator.fileName: File name (relative to the workspace root) where release notes are written. Defaults to RELEASE_NOTES.md.
Development
- Build:
npm run compile
- Watch:
npm run watch
- Lint:
npm run lint
- Tests (compile):
npm run compile-tests
- Package:
npm run package
- VS Code extension package:
NODE_OPTIONS='' vsce package
| |
