Package Exports
- @makispps/releasejet
- @makispps/releasejet/docs/commands.json
- @makispps/releasejet/docs/config-schema.json
- @makispps/releasejet/plugin
- @makispps/releasejet/plugin/templates
Readme
ReleaseJet — the release notes tool for repos with many customers (and for teams that never adopted Conventional Commits).
Collects labeled issues (or merged pull requests) between Git tags, categorizes them, and publishes formatted release notes. First-class support for multi-customer repos (one codebase, per-customer tag tracks) on GitHub and GitLab. No Conventional Commits required — your team already labels issues; that's all we need.
See it live: releasejet-demo-multi-customer — three customer tracks, real published release pages, zero hand-editing.
Full documentation: releasejet.dev/docs
Features
- GitLab and GitHub support — both providers out of the box
- Issues or Pull Requests — closed issues (default) or merged PRs (GitHub)
- Multi-client repos (e.g.,
mobile-v1.0.0,web-v2.0.0) - Configurable categories — map labels to sections
- CI/CD integration — GitLab CI and GitHub Actions
- Strict/lenient modes, milestone detection, contributors section
Quick Start
npm install -g @makispps/releasejet
releasejet init # interactive setup
releasejet generate --tag v1.0.0 # preview
releasejet generate --tag v1.0.0 --publishConfiguration
See the configuration reference for every field. Minimal .releasejet.yml:
provider:
type: github
categories:
feature: "New Features"
bug: "Bug Fixes"CI/CD
GitHub Action on the Marketplace — marketplace/actions/releasejet. Five-line setup:
- uses: makisp/releasejet@v1
with:
tag: ${{ github.ref_name }}
token: ${{ secrets.GITHUB_TOKEN }}Raw setup recipes: GitHub Actions · GitLab CI
Troubleshooting
Common issues:
- "API token not found" — set
RELEASEJET_TOKENas env or viareleasejet init. Full guide. - "Tag not found in remote repository" — push the tag first:
git push origin <tag>. - "Invalid tag format" — see tag formats.
Full troubleshooting · All commands
License
MIT