Skip to content

CI/CD (GitHub Action)

Use the GitHub Action to avoid installing the CLI in your workflow runner. Checksums are verified automatically.

name: Release
on:
push:
branches: [main]
jobs:
release:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: relicta-tech/relicta-action@v2
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
plugins: 'github' # Download GitHub plugin for release creation
config: relicta.config.yaml
env:
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} # Optional: for AI release notes
  • github-token (required for GitHub releases and repo access).
  • plugins: comma-separated list of plugins to download (github, slack, discord, jira, launchnotes, gitlab, npm).
  • config: path to relicta.config.yaml (defaults to repo root).
  • command: full (default), plan, bump, notes, approve, publish.
  • dry-run: true to preview without tagging/publishing.
  • auto-approve: true (default) to skip interactive approval.

See the action docs: https://github.com/relicta-tech/relicta-action

  • Set provider tokens as encrypted secrets (e.g., OPENAI_API_KEY, SLACK_WEBHOOK_URL, NPM_TOKEN, LAUNCHNOTES_API_TOKEN).
  • Ensure actions/checkout fetches tags if you plan to publish (fetch-depth: 0).
  • Plan-only PR check: run publish: false with args: --json and annotate the PR with the proposed version and notes.
  • Manual approval gate: combine with environment protection rules; run publish: true only after approval.
  • Matrix releases: use strategy matrices for multi-platform testing, then a single release job that runs Relicta once.