This action pushes packages to itch.io with butler to easily automate releases.
This action will call butler push
with parameters configured by environment variables.
Example:
steps:
- uses: manleydev/butler-publish-itchio-action@master
env:
BUTLER_CREDENTIALS: ${{ secrets.BUTLER_CREDENTIALS }}
CHANNEL: windows
ITCH_GAME: example-project
ITCH_USER: username
PACKAGE: build/windows
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
The itch.io channel to push to. This would be the platform and artifact you would like to use.
Some examples would be:
You can read more about channel names here: https://itch.io/docs/butler/pushing.html#channel-names
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
.
The username of the owner of the game you are pushing to.
The directory or file to push to Itch.io
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
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