Parameter	Required	Default	Description
folder	❌	.	Custom search folder, if you don't want to search the whole repository.
commit_options	❌	-	Custom git commit options
commit_message	❌	Optimised your images!	Custom git commit message
file_pattern	❌	*	Custom git add file pattern
branch	✅	-	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):

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

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.

Issues

Please report all bugs and feature request using the GitHub issues function. Thanks!