https://github.com/creyd/crush_action
GitHub action for automatic lossless image compression
https://github.com/creyd/crush_action
compression github-actions image-processing lossless
Last synced: over 1 year ago
JSON representation
GitHub action for automatic lossless image compression
- Host: GitHub
- URL: https://github.com/creyd/crush_action
- Owner: creyD
- License: mit
- Created: 2020-03-16T15:27:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-24T15:26:49.000Z (over 1 year ago)
- Last Synced: 2025-02-14T21:17:05.914Z (over 1 year ago)
- Topics: compression, github-actions, image-processing, lossless
- Language: Shell
- Size: 11.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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!