SnapPDF + GitHub Actions

What you can build

• Single `snappdf/action@v1` step does any op via a `command:` input.
• Artifact upload to GitHub releases or Actions artifacts.
• Secrets-friendly: reads `SNAPPDF_API_KEY` from repo secrets.
• Cacheable: pins to a specific action version for reproducibility.
• Self-hosted runners supported — all requests go outbound to api.snappdf.dev.

Setup

1. 01
   Add your SnapPDF key as a repo secret

   GitHub → Settings → Secrets and variables → Actions → New. Name: `SNAPPDF_API_KEY`. Value: your `sk_live_…`.
2. 02
   Reference the action in a workflow

   Use `snappdf/action@v1` in your workflow YAML. Pin a SHA for supply-chain safety.
3. 03
   Configure a command

   Pass a `command` block with the op and args. Inputs and outputs are files in the runner filesystem.
4. 04
   Output the result

   Use `actions/upload-artifact` or `softprops/action-gh-release` to ship the PDF downstream.

Code example

Workflow that generates a release PDF on every tag push.

name: Release PDF

on:
  push:
    tags:
      - 'v*'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Generate API docs
        run: npm run docs:pdf  # outputs docs.pdf

      - name: Merge with changelog
        uses: snappdf/action@v1
        with:
          command: merge
          files: |
            cover.pdf
            docs.pdf
            CHANGELOG.pdf
          output: release-${{ github.ref_name }}.pdf
        env:
          SNAPPDF_API_KEY: ${{ secrets.SNAPPDF_API_KEY }}

      - name: Stamp version
        uses: snappdf/action@v1
        with:
          command: watermark
          input: release-${{ github.ref_name }}.pdf
          output: final.pdf
          args: --text "${{ github.ref_name }}" --position bottom-right --opacity 0.4
        env:
          SNAPPDF_API_KEY: ${{ secrets.SNAPPDF_API_KEY }}

      - uses: softprops/action-gh-release@v2
        with:
          files: final.pdf

FAQ

Related integrations