README.md

setup-butler

🎩 Set up your GitHub Actions workflow with itch.io butler.

Quick Start

name: Upload to itch.io
on: push
jobs:
  itchio-upload:
    runs-on: ubuntu-latest
    steps:
      - name: Setup butler
        uses: remarkablegames/setup-butler@v1

      - name: Upload to itch.io
        # https://itch.io/docs/butler/pushing.html
        run: butler push directory user/game:channel
        env:
          BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }}

The BUTLER_API_KEY is your itch.io API key.

Usage

See action.yml

Basic:

- uses: remarkablegames/setup-butler@v1

Inputs

butler-version

Optional: The CLI version. Defaults to LATEST:

- uses: remarkablegames/setup-butler@v1
  with:
    butler-version: LATEST

cli-name

Optional: The CLI name. Defaults to butler:

- uses: remarkablegames/setup-butler@v1
  with:
    cli-name: butler

Examples

• remarkablegames/phaser-template
• remarkablegames/renpy-template

Contributions

Contributions are welcome!

License

MIT