Workflows & Support/CI/CD & GitHub Actions
Docs/Workflows & Support/CI/CD & GitHub Actions

CI/CD & GitHub Actions

Automate OpenGraph card generation and release screenshot styling in GitHub Actions.

Integrate Imagerry CLI directly into your continuous integration workflows to automatically style release screenshots, social share cards, and documentation assets.

GitHub Actions Workflow

Create .github/workflows/process-assets.yml in your repository:

|yaml
name: Process Assets
on: [push]

jobs:
  style-images:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
          
      - name: Install Imagerry CLI
        run: npm install -g @imagerry/cli
        
      - name: Generate Styled Screenshots
        env:
          IMAGERRY_LICENSE_KEY: ${{ secrets.IMAGERRY_LICENSE_KEY }}
          IMAGERRY_NO_UPDATE_CHECK: '1'
        run: |
          imagerry -i ./raw/hero.png -o ./dist/hero-styled.png --preset mesh --no-update-check
Pro Tip

CI Performance Best Practice

Set IMAGERRY_NO_UPDATE_CHECK=1 or pass --no-update-check in CI/CD environments to bypass external network requests and guarantee zero-latency execution.

Imagerry returns strict POSIX exit code 0 on success and 14 on errors, allowing your CI job to fail gracefully if any file or syntax error occurs.

Warning

Secret Hygiene

Always store your IMAGERRY_LICENSE_KEY as an encrypted GitHub Repository Secret or CI Environment variable. Never commit license keys directly into public git repositories.

Found an issue or typo? Report on GitHub
Imagerry CLI Docs • v0.2.1-beta