2-Minute Integration Quickstart

Pick one path below and go live fast. Each flow is self-contained and can be completed in under 2 minutes.

Before you start

A GitHub account
A connected repository in ShipRelay
At least one pushed tag (e.g., v1.0.0)

Path 1: GitHub Action (recommended)

Best for teams that want a single copy-paste workflow committed in code. For full setup and all inputs, see GitHub Action docs.

yaml

name: 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 }}
          auto-publish: true

Install the ShipRelay GitHub App from the GitHub Marketplace
Copy your API key from Settings → Widget Installation
Add the workflow file to .github/workflows/release.yml
Push a tag: git tag v1.0.0 && git push origin v1.0.0
Check your ShipRelay dashboard — draft appears in ~30 seconds

Path 2: Webhook (automatic)

Connect your repo on the ShipRelay dashboard
Push a tag — the webhook fires automatically
Review the draft in your dashboard
Click Publish → delivered everywhere

Path 3: Manual (dashboard)

Go to your connected repository
Click "Generate Changelog"
Select the tag range and audience
Edit the draft, then publish

Path 4: API (curl)

bash

curl -X POST https://shiprelay.io/api/v1/releases \
  -H "Authorization: Bearer sr_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"repository": "my-app", "tag": "v1.2.0", "audience": "user"}'

Generation is asynchronous. Poll draft status using GET /api/v1/releases/{draftId}, then publish with POST /api/v1/releases/{draftId}/publish.

Need your API key?

Open Settings → Widget Installation, select your repository, and use the repository API key shown in the install snippet.

Tip

For fastest setup, start with Path 1. It keeps release-note generation in version-controlled workflow code and runs on every version tag push.

What's next?

Review GitHub permissions and webhook behavior
Configure outbound publish webhook for Slack/Discord/Zapier
Install the in-app widget to show new releases inside your product

Overview

GitHub Action