Getting Started
First CI run
Get from a green local run to a green CI pipeline in 5 minutes.
GitHub Actions
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 i -g @makispps/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 .gitlab-ci.yml:
release-notes:
stage: deploy
image: node:20-alpine
rules:
- if: $CI_COMMIT_TAG
before_script:
- npm i -g @makispps/releasejet
script:
- releasejet generate --tag "$CI_COMMIT_TAG" --publishSet GITLAB_API_TOKEN (or RELEASEJET_TOKEN) as a CI/CD variable with api scope.
Shortcut
Both files can be generated by:
releasejet ci enable