Skip to main content
Recipes

GitHub + issues

Full config for a GitHub repo driven by closed issues.

.releasejet.yml

provider:
  type: github
source: issues
categories:
  feature: "New Features"
  bug: "Bug Fixes"
  improvement: "Improvements"
  breaking-change: "Breaking Changes"
uncategorized: lenient

GitHub Actions

.github/workflows/release-notes.yml:

name: Release Notes
on:
  push:
    tags:
      - 'v*'
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 i -g @makispps/releasejet
      - run: releasejet generate --tag "${{ github.ref_name }}" --publish
        env:
          RELEASEJET_TOKEN: ${{ secrets.RELEASEJET_TOKEN }}

Workflow

  1. Label issues as they close: feature, bug, improvement, breaking-change.
  2. Push a tag: git tag v1.2.0 && git push origin v1.2.0.
  3. The workflow runs and publishes a GitHub release with categorized notes.

Tips

  • Use milestone detection — set an issue's milestone to the upcoming version and ReleaseJet will link it in the notes.
  • For draft releases, set --publish to off and use --output RELEASE_NOTES.md to stage the content first.

Provider token scopes

Required scopes for GitHub and GitLab API tokens.

GitHub + pull requests

Full config for a GitHub repo driven by merged pull requests.

On this page

.releasejet.ymlGitHub ActionsWorkflowTips