Skip to content
GitHub action that publishes releases to Itch.io using Butler.
Dockerfile Shell
Use this GitHub Action with your project

Add this Action to an existing workflow or create a new one.

View on Marketplace
Branch: master
Clone or download

Latest commit

josephbmanley Merge pull request #1 from relsqui/master
Support package names with spaces in them
Latest commit 1ce8a7c Mar 9, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Dockerfile Only upgrade the package that matters (for speed) Mar 8, 2020
LICENSE
ReadMe.md Intial ReadMe.md file Dec 1, 2019
action.yml Intial dockerized version of butler Dec 1, 2019
entrypoint.sh

ReadMe.md

Butler Push

This action pushes packages to itch.io with butler to easily automated releases.

Usage

This action will call butler push with parameters configured by environment variables.

Example:

steps:
- uses: josephbmanley/butler-publish-itchio-action@master
  env:
    BUTLER_CREDENTIALS: ${{ secrets.BUTLER_CREDENTIALS }}
    CHANNEL: windows
    ITCH_GAME: example-project
    ITCH_USER: username
    PACKAGE: build/windows

Environment Variables

  • BUTLER_CREDENTIALS REQUIRED

    The key used by butler to authenticate.

    How to get credentials

    To get your Butler credentials, you can follow the CI Builds Credentials documentation on Itch.io

  • CHANNEL REQUIRED

    The itch.io channel to push to. This would be the platform and artifact you would like to use.

    Some examples would be:

    • windows
    • linux
    • osx

    You can read more about channel names here: https://itch.io/docs/butler/pushing.html#channel-names

  • ITCH_GAME REQUIRED

    The logical name the game you want to push to.

    Eg. If your URL is https://username.itch.io/example-project, your value for ITCH_GAME would be example-project.

  • ITCH_USER REQUIRED

    The username of the owner of the game you are pushing to.

  • PACKAGE REQUIRED

    The directory or file to push to Itch.io

  • VERSION

    The version of your project to have in your release.

    Note: If both VERSION and VERSION_FILE are empty, versioning will be handled by Itch.io

  • VERSION_FILE

    The file containing your version number to have in your release.

    Note: If both VERSION and VERSION_FILE are empty, versioning will be handled by Itch.io

You can’t perform that action at this time.