https://github.com/rageagainstthepixel/setup-butler
A Github Action to setup the butler command line tool for itch.io content authoring.
https://github.com/rageagainstthepixel/setup-butler
actions butler game-ci github github-actions github-actions-tool itch itch-io itchio tool-cache
Last synced: 3 months ago
JSON representation
A Github Action to setup the butler command line tool for itch.io content authoring.
- Host: GitHub
- URL: https://github.com/rageagainstthepixel/setup-butler
- Owner: RageAgainstThePixel
- License: mit
- Created: 2024-12-04T13:37:14.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-01-22T01:24:10.000Z (5 months ago)
- Last Synced: 2025-02-01T07:42:55.162Z (5 months ago)
- Topics: actions, butler, game-ci, github, github-actions, github-actions-tool, itch, itch-io, itchio, tool-cache
- Language: TypeScript
- Homepage: https://github.com/itchio/butler
- Size: 33.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# setup-butler
A Github Action to setup the [butler](https://github.com/itchio/butler) command line tools for itch.io content authoring.
## How to use
### workflow
```yaml
jobs:
validate:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [macos-latest, windows-latest, ubuntu-latest]
steps:
# download and setup butler
- uses: RageAgainstThePixel/setup-butler@v1
with:
api-key: ${{ secrets.BUTLER_API_KEY }}
# run butler
- run: butler --version
```
### inputs
| name | description | required |
| ---- | ----------- | -------- |
| `api-key` | An [api key for your itch.io account](https://itch.io/user/settings/api-keys) | true |
| `version` | The version of butler to install. Defaults to `latest`. | false |
| `self-update` | Update butler to the latest version. Defaults to `true`. | false |
### outputs
### environment variables
- `BUTLER_PATH`: The `butler` directory location.
- `BUTLER_DIR`: The directory where butler is installed.