https://github.com/remarkablegames/setup-butler
🎩 Set up GitHub Actions workflow with itch.io butler
https://github.com/remarkablegames/setup-butler
action actions butler cli github github-action github-actions itchio workflow
Last synced: 5 months ago
JSON representation
🎩 Set up GitHub Actions workflow with itch.io butler
- Host: GitHub
- URL: https://github.com/remarkablegames/setup-butler
- Owner: remarkablegames
- License: mit
- Created: 2024-02-24T19:57:14.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-05-02T14:43:00.000Z (about 1 year ago)
- Last Synced: 2025-05-02T15:45:00.437Z (about 1 year ago)
- Topics: action, actions, butler, cli, github, github-action, github-actions, itchio, workflow
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/setup-butler
- Size: 1.51 MB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# setup-butler
[](https://github.com/remarkablegames/setup-butler/releases)
[](https://github.com/remarkablegames/setup-butler/actions/workflows/build.yml)
[](https://codecov.io/gh/remarkablegames/setup-butler)
🎩 Set up your GitHub Actions workflow with [itch.io](https://itch.io/) [butler](https://itch.io/docs/butler/).
## Quick Start
```yaml
name: Upload to itch.io
on: push
jobs:
itchio-upload:
runs-on: ubuntu-latest
steps:
- name: Setup butler
uses: remarkablegames/setup-butler@v2
# https://itch.io/docs/butler/pushing.html
- name: Upload to itch.io
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](https://itch.io/user/settings/api-keys).
## Usage
Set up butler CLI:
```yaml
- uses: remarkablegames/setup-butler@v2
```
See [action.yml](action.yml)
## Inputs
### `butler-version`
**Optional**: The CLI [version](https://broth.itch.zone/butler). Defaults to `LATEST`:
```yaml
- uses: remarkablegames/setup-butler@v2
with:
butler-version: LATEST
```
### `cli-name`
**Optional**: The CLI name. Defaults to `butler`:
```yaml
- uses: remarkablegames/setup-butler@v2
with:
cli-name: butler
```
## Examples
- [phaser-template](https://github.com/remarkablegames/phaser-template/blob/master/.github/workflows/release-please.yml)
- [renpy-template](https://github.com/remarkablegames/renpy-template/blob/master/.github/workflows/release-please.yml)
## License
[MIT](LICENSE)