mirror of
https://github.com/creyD/crush_action.git
synced 2026-04-12 19:50:29 +02:00
76 lines
2.2 KiB
Markdown
76 lines
2.2 KiB
Markdown
# GitHub Crush Action
|
|
|
|
GitHub action for automatic lossless image compression using [OptiPNG](http://optipng.sourceforge.net/) for PNG compression and [jpegoptim](https://www.kokkonen.net/tjko/projects.html) for JPG compression.
|
|
|
|
## Usage
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Required | Default | Description |
|
|
| - | :-: | :-: | - |
|
|
| folder | :x: | . | Custom search folder, if you don't want to search the whole repository. |
|
|
| commit_options | :x: | - | Custom git commit options |
|
|
| commit_message | :x: | Optimised your images! | Custom git commit message |
|
|
| file_pattern | :x: | * | Custom git add file pattern |
|
|
| branch | :white_check_mark: | - | There are two types of action triggers in GitHub: on pull request and on push. The branch needs to be defined for both, but in case of the pull request trigger it should have `${{ github.head_ref }}` and on push it should have the branch the trigger is designed for. |
|
|
|
|
### Example Config
|
|
|
|
#### Example - On Pull Request
|
|
|
|
This is a small example of what your `action.yml` could look like (on pull request mode):
|
|
|
|
```yaml
|
|
name: Optimising Pictures
|
|
|
|
on: [pull_request]
|
|
|
|
jobs:
|
|
cleanup_tasks:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Cloning the repository
|
|
uses: actions/checkout@v1
|
|
with:
|
|
fetch-depth: 1
|
|
- name: Crush Images!
|
|
uses: creyD/crush_action@v1.0
|
|
with:
|
|
branch: ${{ github.head_ref }}
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
```
|
|
|
|
#### Example - On Push
|
|
|
|
```yaml
|
|
name: Optimising Pictures
|
|
|
|
on:
|
|
push:
|
|
branches: [master]
|
|
|
|
jobs:
|
|
cleanup_tasks:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Cloning the repository
|
|
uses: actions/checkout@v1
|
|
with:
|
|
fetch-depth: 1
|
|
- name: Crush Images!
|
|
uses: creyD/crush_action@v1.0
|
|
with:
|
|
branch: master
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
```
|
|
|
|
More documentation for writing a workflow can be found [here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).
|
|
|
|
## Issues
|
|
|
|
Please report all bugs and feature request using the [GitHub issues function](https://github.com/creyD/crush_action/issues/new). Thanks!
|