ImageMagick GH Action

GitHub Action to wrap ImageMagick features

---

• ⬆️ Top of Document
• 🏗️ Requirements
• ⚡ Quick Start
• 🧰 Usage
  • Example GitHub Pages -- Jekyll
• 🗒 Notes
• 📈 Contributing
  • 🔱 Forking
  • 💱 Sponsor
• 📇 Attribution
• ⚖️ Licensing

---

Requirements

Access to GitHub Actions if using on GitHub, or manually assigning expected environment variables prior to running entrypoint.sh script.

---

Quick Start

Include, and modify, the following within your repository's workflow that published to GitHub Pages

      - name: Convert images
        uses: gha-utilities/[email protected]
        with:
          source_directory: assets/images
          find_regex: '.*.png'
          destination_extensions: jpeg,avif

---

Usage

Reference the code of this repository within your own workflow...

Example GitHub Pages -- Jekyll

.github/workflows/github-pages.yaml

on:
  push:
    branches: [ gh-pages ]

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      # Caching is recommended!
      - name: Cache assets/images
        uses: actions/cache@v4
        with:
          key: ${{ hashFiles('assets/images/**/*.png') }}
          path: assets/images

      - name: Checkout source
        uses: actions/checkout@v4
        with:
          fetch-depth: 1
          fetch-tags: true
          ref: ${{ github.head_ref }}
          submodules: 'recursive'

      - name: Convert images
        uses: gha-utilities/[email protected]
        with:
          source_directory: assets/images
          find_regex: '*.png'
          destination_extensions: jpeg,avif

      # ↓ Do some site building here ↓
      - name: Setup pages
        uses: actions/[email protected]
      - name: Build pages
        uses: actions/jekyll-build-pages@v1
      # ↑ Do some site building here ↑

      - name: Upload artifact
        uses: actions/[email protected]

  deploy:
    runs-on: ubuntu-latest
    needs: build

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/[email protected]

---

Notes

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.

Check the action.yaml file for input/output documentation.

To prevent duplicate deployments caused by default gh-pages branch behavior, be sure to update the repository Settings → Pages → GitHub Pages → Build and deployment → Source configuration to use "GitHub Actions"

https://github.com/<ACCOUNT>/<REPO>/settings/pages

---

Contributing

Options for contributing to ImageMagick GH Action and gha-utilities

---

Forking

Start making a Fork of this repository to an account that you have write permissions for.

• Add remote for fork URL. The URL syntax is [email protected]:<NAME>/<REPO>.git...

cd ~/git/hub/gha-utilities/ImageMagick

git remote add fork [email protected]:<NAME>/ImageMagick.git

• Commit your changes and push to your fork, eg. to fix an issue...

cd ~/git/hub/gha-utilities/ImageMagick


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF


git push fork main

Note, the -u option may be used to set fork as the default remote, eg. git push -u fork main however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull origin main

• Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.

---

Sponsor

Thanks for even considering it!

Via Liberapay you may on a repeating basis.

Regardless of if you're able to financially support projects such as ImageMagick GH Action that gha-utilities maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.

---

Attribution

• Docs ImageMagick -- Configuration Files
• Docs ImageMagick -- Convert
• GitHub -- github-utilities/make-readme
• GitHub Docs -- Metadata syntax for GitHub Actions outputs for composite actions

---

License

GitHub Action to wrap ImageMagick features
Copyright (C) 2025 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.