GitHub Action

getshiprelay/release-action@v1 is the recommended ShipRelay integration path for CI-driven releases.

Overview

On every tag push, the action calls ShipRelay's release API, starts async changelog generation, waits for draft readiness, and optionally publishes immediately.

Full workflow YAML

name: ShipRelay Release Notes
on:
  push:
    tags: ['v*']

jobs:
  changelog:
    runs-on: ubuntu-latest
    steps:
      - uses: getshiprelay/release-action@v1
        with:
          api-key: ${{ secrets.SHIPRELAY_API_KEY }}
          audience: user
          auto-publish: false

Inputs

Setup

1. Install the ShipRelay GitHub App.
2. Copy your API key from Settings → Widget Installation.
3. Add SHIPRELAY_API_KEY as a repository secret in GitHub: Settings → Secrets and variables → Actions.
4. Create .github/workflows/release.yml with the YAML above.
5. Push a tag: git tag v1.2.0 && git push origin v1.2.0.

Troubleshooting

• API key invalid: confirm the key is active and saved as SHIPRELAY_API_KEY.
• Tag not found: run on tag pushes (refs/tags/*) and push the tag to origin.
• Repository not connected: verify the repo is connected in ShipRelay and the GitHub App is installed.
• Permission issues: ensure the workflow has access to repository secrets and runs on the correct repository.