creyD/crush_action
1
0
Fork 0
mirror of https://github.com/creyD/crush_action.git synced 2026-04-12 11:40:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Finishing Touches for 1.0

Browse Source
This commit is contained in:
Conrad
2020-03-18 14:44:18 +01:00
parent b94afd2dd0
commit 1c6132258a
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,6 +1,6 @@
# GitHub Crush Action # GitHub Crush Action
GitHub action for automatic lossless image compression using OptiPNG for PNG compression and jpegoptim for JPG compression. 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 ## Usage
@@ -8,11 +8,11 @@ GitHub action for automatic lossless image compression using OptiPNG for PNG com
| Parameter | Required | Default | Description | | 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_options | :x: | - | Custom git commit options |
| commit_message | :x: | Prettified Code! | Custom git commit message | | commit_message | :x: | Optimised your images! | Custom git commit message |
| file_pattern | :x: | * | Custom git add file pattern | | 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. | | 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. |
| folder | :x: | . | Custom search folder, if you don't want to search the whole repository. |
### Example Config ### Example Config
@@ -34,7 +34,7 @@ jobs:
uses: actions/checkout@v1 uses: actions/checkout@v1
with: with:
fetch-depth: 1 fetch-depth: 1
- name: Prettify the JS Code - name: Crush Images!
uses: creyD/crush_action@v1.0 uses: creyD/crush_action@v1.0
with: with:
branch: ${{ github.head_ref }} branch: ${{ github.head_ref }}
@@ -60,7 +60,7 @@ jobs:
uses: actions/checkout@v1 uses: actions/checkout@v1
with: with:
fetch-depth: 1 fetch-depth: 1
- name: Prettify the JS Code - name: Crush Images!
uses: creyD/crush_action@v1.0 uses: creyD/crush_action@v1.0
with: with:
branch: master branch: master

4
action.yml
View File

@@ -1,5 +1,5 @@
name: Crush Action name: Crush Action
description: Losslessly reduces file size for PNGs description: Losslessly reduces file size for PNG and JPG
author: Conrad Großer <grosserconrad@gmail.com> author: Conrad Großer <grosserconrad@gmail.com>
@@ -28,5 +28,5 @@ runs:
image: 'Dockerfile' image: 'Dockerfile'
branding: branding:
icon: 'award' icon: 'aperture'
color: 'green' color: 'green'