https://github.com/namoscato/action-tinify
GitHub Action to compress and resize images with the Tinify API
https://github.com/namoscato/action-tinify
compression github-actions image optimization tinify tinyjpg tinypng
Last synced: 4 months ago
JSON representation
GitHub Action to compress and resize images with the Tinify API
- Host: GitHub
- URL: https://github.com/namoscato/action-tinify
- Owner: namoscato
- License: mit
- Created: 2020-05-30T01:01:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-10T17:57:29.000Z (almost 2 years ago)
- Last Synced: 2025-03-14T10:17:13.296Z (7 months ago)
- Topics: compression, github-actions, image, optimization, tinify, tinyjpg, tinypng
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/tinify-image-action
- Size: 2.36 MB
- Stars: 39
- Watchers: 1
- Forks: 7
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/namoscato/action-tinify/actions/workflows/ci.yml) [](https://hub.docker.com/r/namoscato/github-action-tinify)
# Tinify Image Action
[GitHub Action](https://github.com/features/actions) to compress and resize images with the [Tinify API](https://tinypng.com/developers).
## Features
- filters PNG, JPEG, and WebP files in a commit or pull request
- optionally scales images proportionally
- sets Exif metadata to prevent duplicate compressions
- pushes commit with compression metrics
## Usage
For example, on [`pull_request` events](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths) with modified files inside the `static` directory:
```yaml
name: Compress Images
on:
pull_request:
paths:
- 'static/**'
jobs:
compress:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
- uses: namoscato/action-tinify@v1
with:
api_key: ${{ secrets.TINIFY_API_KEY }}
```
### Events
The following [webhook events](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#webhook-events) are supported:
- `pull_request`
- `push`
> [!IMPORTANT]
> In pull request contexts, [`actions/checkout`](https://github.com/actions/checkout) checkouts a _merge_ commit by default. You must checkout the pull request _HEAD_ commit by overriding the `ref` input as illustrated above and as noted in [their documentation](https://github.com/actions/checkout#Checkout-pull-request-HEAD-commit-instead-of-merge-commit).
### Commit Behavior
Events triggered by a default `GITHUB_TOKEN` commit [will **not** create a new workflow run](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow) to prevent accidental recursion.
If you are sure that you want the compression commit to trigger a workflow run, you can configure [`actions/checkout`](https://github.com/actions/checkout) with a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens):
```yaml
- uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
```
### Inputs
| input | description |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`api_key`** | Required Tinify API key (create one [here](https://tinypng.com/developers)) |
| `github_token` | Repository `GITHUB_TOKEN` or personal access token secret; defaults to [`github.token`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication) |
| `commit_user_name` | Git user.name, defaults to `github.actor` |
| `commit_user_email` | Git user.email, defaults to `@users.noreply.github.com` |
| `commit_message` | Custom commit message, defaults to `Compress image(s)` |
| `resize_width` | Maximum target image width |
| `resize_height` | Maximum target image height |