Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/calibreapp/image-actions
A Github Action that automatically compresses JPEGs, PNGs and WebPs in Pull Requests.
https://github.com/calibreapp/image-actions
compression github-action github-actions image-compression image-processing performance performance-monitoring performance-testing
Last synced: 3 days ago
JSON representation
A Github Action that automatically compresses JPEGs, PNGs and WebPs in Pull Requests.
- Host: GitHub
- URL: https://github.com/calibreapp/image-actions
- Owner: calibreapp
- License: gpl-3.0
- Created: 2019-04-16T05:00:42.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T23:01:18.000Z (about 1 month ago)
- Last Synced: 2025-01-01T18:05:34.556Z (10 days ago)
- Topics: compression, github-action, github-actions, image-compression, image-processing, performance, performance-monitoring, performance-testing
- Language: TypeScript
- Homepage: https://calibreapp.com/blog/compress-images-in-prs
- Size: 2.85 MB
- Stars: 1,435
- Watchers: 17
- Forks: 68
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome - calibreapp/image-actions - A Github Action that automatically compresses JPEGs, PNGs and WebPs in Pull Requests. (TypeScript)
README
# Calibre Image Actions
[](https://www.npmjs.com/package/react-live-chat-loader)
[](https://github.com/calibreapp/react-live-chat-loader/blob/main/LICENSE)
[](CODE_OF_CONDUCT.md)
[](CONTRIBUTING.md)
Image Actions is a Github Action built by performance experts at [Calibre](https://calibreapp.com/) that automatically compresses JPEGs, PNGs and WebPs in Pull Requests.
Image Actions offers:
- **Fast, efficient and near-lossless compression**
- Best image compression algorithms available ([libvips](https://github.com/libvips/libvips))
- [Ease of customisation](#Configuration): use default settings or adapt to your needs
- Running on demand or schedule
- Supports GitHub Enterprise
...and more!
## 🖇 Table of Contents
1. [Usage](#-usage)
2. [Configuration](#%EF%B8%8F-configuration)
3. [Migrating legacy configuration](#%EF%B8%8F-migrating-legacy-configuration)
4. [Contributing](#-contributing)
5. [Resources](#-resources)
6. [License](#-license)
## 🛠 Usage
1. Create a `.github/workflows/calibreapp-image-actions.yml` file in your repository with the following configuration:
```yml
name: Compress Images
on:
pull_request:
# Run Image Actions when JPG, JPEG, PNG or WebP files are added or changed.
# See https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onpushpull_requestpaths for reference.
paths:
- '**.jpg'
- '**.jpeg'
- '**.png'
- '**.webp'
jobs:
build:
# Only run on Pull Requests within the same repository, and not from forks.
if: github.event.pull_request.head.repo.full_name == github.repository
name: calibreapp/image-actions
permissions: write-all
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v4
- name: Compress Images
uses: calibreapp/image-actions@main
with:
# The `GITHUB_TOKEN` is automatically generated by GitHub and scoped only to the repository that is currently running the action. By default, the action can’t update Pull Requests initiated from forked repositories.
# See https://docs.github.com/en/actions/reference/authentication-in-a-workflow and https://help.github.com/en/articles/virtual-environments-for-github-actions#token-permissions
githubToken: ${{ secrets.GITHUB_TOKEN }}
```
2. Open a Pull Request with added or changed imagery. Image Actions will process the files and post a comment, like so:
3. Merge your Pull Request and enjoy lighter images or explore what’s possible further with [configuration options](#configuration). 👇🏻
## ⚙️ Configuration
By default, Image Actions will compress images so that they’re smaller and will leave your assets looking clear and crisp. If you want to change or expand those defaults, read on for available options.
:warning: If you are using an older version of Image Actions referencing `.github/calibre/image-actions.yml`, we suggest you [migrate to the latest configuration format](#migrate-legacy-configuration).
### Control image quality settings
Add the following arguments to the workflow definition to control compression settings:
```yml
with:
jpegQuality: '80'
jpegProgressive: false
pngQuality: '80'
webpQuality: '80'
```
**Options:**
- [jpegQuality](http://sharp.pixelplumbing.com/en/stable/api-output/#jpeg): Number, integer 1-100, default 80 stored in a string.
- [jpegProgressive](http://sharp.pixelplumbing.com/en/stable/api-output/#jpeg): Boolean, true or false, default false.
- [pngQuality](http://sharp.pixelplumbing.com/en/stable/api-output/#png): Number, integer 1-100, default 80 stored in a string.
- [webpQuality](http://sharp.pixelplumbing.com/en/stable/api-output/#webp): Number, integer 1-100, default 80 stored in a string.
### Ignore paths
Add the following argument to the workflow definition to ignore selected paths:
```yml
with:
ignorePaths: 'node_modules/**,build'
```
`ignorePaths` accepts a comma-separated string with [globbing](https://www.npmjs.com/package/glob) support of paths to ignore when looking for images to compress.
### Run compression only
By default, Image Actions adds optimised images to the current Pull Request and posts a summary comment.
Use the `compressOnly` option with `true` value to skip the commit and summary comment if you want to handle this separately (including for forks):
```yml
with:
compressOnly: true
```
`compressOnly` accepts a Boolean value (true or false) and defaults to false.
### Compress on demand or on schedule
It is also possible to run Image Actions [on demand](https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/) or on a [recurring schedule](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#schedule). By using the `compressOnly` option, in conjunction with [`create-pull-request`](https://github.com/peter-evans/create-pull-request) action by [@peter-evans](https://github.com/peter-evans), a new Pull Request will be raised if there are optimised images in a repository.
See an example below:
```yml
# Compress images on demand (workflow_dispatch), and at 11pm every Sunday (schedule).
# Open a Pull Request if any images can be compressed.
name: Compress Images
on:
workflow_dispatch:
schedule:
- cron: '00 23 * * 0'
jobs:
build:
name: calibreapp/image-actions
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v3
- name: Compress Images
id: calibre
uses: calibreapp/image-actions@main
with:
githubToken: ${{ secrets.GITHUB_TOKEN }}
compressOnly: true
- name: Create New Pull Request If Needed
if: steps.calibre.outputs.markdown != ''
uses: peter-evans/create-pull-request@v4
with:
title: Compressed Images Nightly
branch-suffix: timestamp
commit-message: Compressed Images
body: ${{ steps.calibre.outputs.markdown }}
```
### Process Pull Requests from forked repositories
By default, GitHub Actions do not have permission to alter forked repositories. For this reason, Image Actions only works for Pull Requests from branches in the same repository as the destination branch. There are several workarounds for this limitation:
1. **Replace the default `GITHUB_TOKEN` with a [Personal Access Token (PAT)](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token) which does have permission to access forked repositories.** Be aware that this introduces potential security concerns (which is why it not available by default).
2. **Run Image Actions only for Pull Requests in the current repository.** This approach is advised when not using Personal Access Tokens (PATs) to avoid wasting time and compute for compressions that will not be committed. Use the following configuration to check if a Pull Request belongs to the repository:
```yml
if: github.event.pull_request.head.repo.full_name == github.repository
```
3. **Run an additional instance of Image Actions in `compressOnly` mode on pushes to `main`, and then raise a new Pull Request for any images committed without being compressed (e.g. from a forked repository PR).** See the configuration in the below example which uses the [create-pull-request](https://github.com/peter-evans/create-pull-request) action by [@peter-evans](https://github.com/peter-evans) to open the new Pull Request (this only raises a Pull Request if any files are changed in previous steps).
```yml
name: Compress Images on Push to main branch
on:
push:
branches:
- main
paths:
- '**.jpg'
- '**.jpeg'
- '**.png'
- '**.webp'
jobs:
build:
name: calibreapp/image-actions
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v3
- name: Compress Images
id: calibre
uses: calibreapp/image-actions@main
with:
githubToken: ${{ secrets.GITHUB_TOKEN }}
compressOnly: true
- name: Create New Pull Request If Needed
if: steps.calibre.outputs.markdown != ''
uses: peter-evans/create-pull-request@v4
with:
title: Compressed Images
branch-suffix: timestamp
commit-message: Compressed Images
body: ${{ steps.calibre.outputs.markdown }}
```
### Combined workflow
You can combine all of the above customisation options into one all-encompassing workflow to avoid having to set up separate workflows with a lot of duplication.
The example below ensures the right order of task execution within Image Actions. If you’d like to reuse it, make sure to change `example/example_repo` to your repository details.
```yml
# Image Actions will run in the following scenarios:
# - on Pull Requests containing images (not including forks)
# - on pushing of images to `main` (for forks)
# - on demand (https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/)
# - at 11 PM every Sunday in anything gets missed with any of the above scenarios
# For Pull Requests, the images are added to the PR.
# For other scenarios, a new PR will be opened if any images are compressed.
name: Compress images
on:
pull_request:
paths:
- '**.jpg'
- '**.jpeg'
- '**.png'
- '**.webp'
push:
branches:
- main
paths:
- '**.jpg'
- '**.jpeg'
- '**.png'
- '**.webp'
workflow_dispatch:
schedule:
- cron: '00 23 * * 0'
jobs:
build:
name: calibreapp/image-actions
runs-on: ubuntu-latest
# Only run on main repo on and PRs that match the main repo.
if: |
github.repository == 'example/example_repo' &&
(github.event_name != 'pull_request' ||
github.event.pull_request.head.repo.full_name == github.repository)
steps:
- name: Checkout Branch
uses: actions/checkout@v3
- name: Compress Images
id: calibre
uses: calibreapp/image-actions@main
with:
githubToken: ${{ secrets.GITHUB_TOKEN }}
# For non-Pull Requests, run in compressOnly mode and we'll PR after.
compressOnly: ${{ github.event_name != 'pull_request' }}
- name: Create Pull Request
# If it's not a Pull Request then commit any changes as a new PR.
if: |
github.event_name != 'pull_request' &&
steps.calibre.outputs.markdown != ''
uses: peter-evans/create-pull-request@v4
with:
title: Auto Compress Images
branch-suffix: timestamp
commit-message: Compress Images
body: ${{ steps.calibre.outputs.markdown }}
```
## ♻️ Migrating legacy configuration
If you are using an older version of Image Actions, we recommend checking that your settings are up-to-date.
### Uses and `GITHUB_TOKEN` definition
If your `calibreapp-image-actions.yml` file has a reference to `docker://` or `GITHUB_TOKEN` as follows:
```yml
- name: calibreapp/image-actions
uses: docker://calibreapp/github-image-actions
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Update your configuration to:
```yml
- name: Compress Images
uses: calibreapp/image-actions@main
with:
githubToken: ${{ secrets.GITHUB_TOKEN }}
```
### Location and name of the configuration file
If your repository uses `.github/calibre/image-actions.yml` for configuration, it should be moved into `.github/workflows/calibreapp-image-actions.yml`. Then delete the `image-actions.yml` file.
### Listing `ignorePaths`
`ignorePaths` is no longer an array and is now a comma separated list. E.g. `ignorePaths: "node_modules/**,bin"`.
## 🙌🏻 Contributing
Happy to hear you’re interested in contributing to Image Actions! Please find our contribution guidelines [here](CONTRIBUTING.md).
## 📚 Resources
#### Related reading:
- [Automatically compress images on Pull Requests](https://calibreapp.com/blog/compress-images-in-prs/)
- [Optimize Images with a GitHub Action](https://css-tricks.com/optimize-images-with-a-github-action/)
- [Image Actions on GitHub Marketplace](https://github.com/marketplace/actions/image-actions)
- [Start monitoring and improving your performance](https://calibreapp.com/)
#### Image compression tools:
- [sharp](https://github.com/lovell/sharp)
- [libvips](https://github.com/libvips/libvips)
## 💼 License
This project is licensed under a [GNU General Public License](LICENSE).