Skip to content
upload

GitHub Action

Butler to Itch

v1.0.0 Latest version

Butler to Itch

upload

Butler to Itch

Install Butler and upload to itch.io

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Butler to Itch

uses: Ayowel/butler-to-itch@v1.0.0

Learn more about this action in Ayowel/butler-to-itch

Choose a version

Butler to Itch

License Latest version

This action installs Butler and uses it to push assets to itch.io

Usage

Your Butler key should be saved as a secret.

Release a project

This example pushes 5 files to Itch, each in a dedicated channel.

# .github/workflows/release.yml
name: Release project
on:
  workflow_dispatch:

jobs:
  release:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3
      - uses: Ayowel/butler-to-itch@v1.0.0
        with:
          butler_key: ${{ secrets.BUTLER_CREDENTIALS }}
          itch_user: Ayowel
          itch_game: renpy-extensions-demo
          version: ${{ github.ref_name }}
          # We assume that we have the following files in ./build:
          # release-linux.tar.gz, release-windows.zip,
          # release-mac.zip, java-release.apk
          files: |
                   build/release-*
            doc    docs/html
            mobile build/java-*

Inputs

The step configuration looks like this:

- uses: Ayowel/butler-to-itch@v1.0.0
  with:
    # Whether to install Butler or to push a file.
    # This may be used when you want to use Butler with custom
    # commands.
    action: "push"
    # Where Butler should be installed.
    install_dir: ~/.butler

    ###### Push options ######
    # Your butler key (see https://itch.io/user/settings/api-keys)
    butler_key: ""
    # The itch username of the user that distributes the game
    itch_user: ""
    # The name of the game in the project's url
    itch_game: ""
    # The game version number
    version: ""
    # The files to push to itch.
    # File paths support globing and may start with a channel name.
    files: ""
    # If no channel is provided for a file, to generate one from the
    # file's name.
    auto_channel: true

    ###### Install options ######
    # Whether to verify the downloaded Butler archive's signature
    check_signature: true
    # Whether to update the PATH variable to include Butler's
    # install directory
    update_path: false
    # Which Butler version to install
    butler_version: "latest"

Outputs

Output name Description
install_dir Path to Butler's install directory

Implementation details

Behavior of auto_channel

auto_channel parses the file name to build a channel string.

Channel Matched strings
doc doc, docs, documentation
web web, html, html5
android android, mobile
linux linux, unix, gnu
mac mac, macintosh, macos, macosx, osx
windows win, windows, xp
x32 x32
x64 x64
  • If more than one channel string matches, the resulting channel is all maches separated by a "-".
  • String matching is case-insensitive
  • Strings match only if the string is delimited by ., _, -, or the start of the filename.

Channel names in files

Channel names in the files input field may only contain lowercase alphanumerical characters and hyphens, or they won't be recognized as such.