JSPM

Automated release notes generator for GitLab and GitHub. Collects closed issues (or merged pull requests) between Git tags, categorizes them by label, and publishes formatted release notes.

Features

• GitLab and GitHub support — works with both providers out of the box
• Issues or Pull Requests — generate notes from closed issues (default) or merged PRs (GitHub)
• Multi-client repos — filter by client label (e.g., mobile-v1.0.0, web-v2.0.0)
• Single-client repos — just use v<semver> tags
• Configurable categories — map labels to sections (features, bugs, improvements, etc.)
• CI/CD integration — runs automatically on tag push via GitLab CI or GitHub Actions
• Strict/lenient modes — enforce labeling or allow uncategorized issues under "Other"
• Milestone detection — automatically links the most common milestone in release notes

Quick Start

npm install -g releasejet

# Interactive setup (detects provider from git remote)
releasejet init

# Preview release notes
releasejet generate --tag v1.0.0

# Generate and publish
releasejet generate --tag v1.0.0 --publish

Configuration

Create .releasejet.yml in your project root (or run releasejet init):

provider:
  type: github       # 'gitlab' or 'github'
  url: https://github.com

# GitHub-only: generate notes from issues or pull requests
source: issues       # 'issues' (default) or 'pull_requests'

# For multi-client repos (omit for single-client)
clients:
  - prefix: mobile
    label: MOBILE
  - prefix: web
    label: WEB

categories:
  feature: "New Features"
  bug: "Bug Fixes"
  improvement: "Improvements"
  breaking-change: "Breaking Changes"

uncategorized: lenient  # or "strict" to enforce labeling

CI/CD Integration

GitHub Actions

Run releasejet init and select CI setup, or add .github/workflows/release-notes.yml:

name: Release Notes
on:
  push:
    tags:
      - '**'
jobs:
  release-notes:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm install -g releasejet
      - run: releasejet generate --tag "${{ github.ref_name }}" --publish
        env:
          RELEASEJET_TOKEN: ${{ secrets.RELEASEJET_TOKEN }}

Set RELEASEJET_TOKEN as a repository secret (Settings > Secrets > Actions).

GitLab CI

Add to your .gitlab-ci.yml (or run releasejet ci enable):

release-notes:
  stage: deploy
  image: node:20-alpine
  rules:
    - if: $CI_COMMIT_TAG
  before_script:
    - npm install -g releasejet
  script:
    - releasejet generate --tag "$CI_COMMIT_TAG" --publish

Set GITLAB_API_TOKEN (or RELEASEJET_TOKEN) as a CI/CD variable with api scope.

Authentication

Token resolution order:

1. RELEASEJET_TOKEN env var (works for both providers)
2. Provider-specific env var: GITLAB_API_TOKEN or GITHUB_TOKEN
3. Stored credentials from ~/.releasejet/credentials.yml

Tag Format

Commands

Generate Flags

License

MIT