You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Tinify Image Action
v1.3.1
GitHub Action to compress and resize images with the Tinify API.
- filters PNG and JPEG files in a commit or pull request
- optionally scales images proportionally
- sets Exif metadata to prevent duplicate compressions
- pushes commit with compression metrics
name: image
on: [pull_request]
jobs:
compress:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}
- uses: namoscato/action-tinify@v1
with:
api_key: ${{ secrets.TINIFY_API_KEY }}
github_token: ${{ secrets.GITHUB_TOKEN }}
The following webhook events are supported:
pull_request
push
In pull request contexts, 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.
input | description |
---|---|
api_key |
Tinify API key (create one here) |
github_token |
GITHUB_TOKEN secret |
commit_user_name |
Git user.name, defaults to github.actor |
commit_user_email |
Git user.email, defaults to <github.actor>@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 |