Automate release notes on every tag push.

1. 1

   Push a version tag

   Tag your commit with a semantic version (v1.2.3). The action triggers automatically.

2. 2

   ShipRelease analyzes diffs

   The action calls the ShipRelease API, which reads your code diffs between the previous tag and the new one.

3. 3

   Notes are generated

   Claude AI produces release notes in the format you configured (technical, product, or customer).

4. 4

   GitHub Release created (optional)

   With publish-to-github: true, the action creates a GitHub Release with the generated notes automatically.

Add the following workflow file to your repository at .github/workflows/release-notes.yml:

name: Generate Release Notes

on:
  push:
    tags:
      - 'v*'

jobs:
  release-notes:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Generate Release Notes
        uses: shiprelease/action@v1
        with:
          # [CLIENT : AJOUTER comme secret GitHub dans Settings → Secrets]
          api-key: ${{ secrets.SHIPRELEASE_API_KEY }}
          format: 'product'        # technical | product | customer
          publish-to-github: true  # Creates a GitHub Release automatically
          version: ${{ github.ref_name }}

Generate your API key in your ShipRelease dashboard under Settings → API Keys. Then add it as a GitHub Secret in your repository: Settings → Secrets → Actions → New secret.

• Name the secret SHIPRELEASE_API_KEY
• Paste your API key from the ShipRelease dashboard
• Click "Add secret"