setup-butler

A Github Action to setup the butler command line tools for itch.io content authoring.

How to use

workflow

jobs:
  validate:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [macos-latest, windows-latest, ubuntu-latest]
    steps:
      # download and setup butler
      - uses: RageAgainstThePixel/setup-butler@v2
        with:
          api-key: ${{ secrets.BUTLER_API_KEY }}
      # run butler commands
      - 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 }}

inputs

name	description	required
api-key	An api key for your itch.io account	true
version	The version of butler to install. Defaults to latest.	false

outputs

• path: The full path to the butler executable.
• version: The installed butler version.

environment variables

• BUTLER_PATH: The full path to the butler executable.
• BUTLER_DIR: The directory where butler is installed.