https://github.com/jdno/setup-butler
Set up itch.io's butler tool in your GitHub Actions workflow
https://github.com/jdno/setup-butler
butler github-actions itch-io
Last synced: about 1 month ago
JSON representation
Set up itch.io's butler tool in your GitHub Actions workflow
- Host: GitHub
- URL: https://github.com/jdno/setup-butler
- Owner: jdno
- License: mit
- Created: 2022-04-06T06:57:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-16T05:45:01.000Z (7 months ago)
- Last Synced: 2025-03-16T12:11:41.970Z (7 months ago)
- Topics: butler, github-actions, itch-io
- Language: TypeScript
- Homepage:
- Size: 1.65 MB
- Stars: 4
- Watchers: 2
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# setup-butler
This action downloads [butler], a command-line tool by [itch.io], and adds it to
the `PATH`.
## Usage
Simply run `setup-butler` in a workflow to add the `butler` command-line tool to
the `PATH`:
```yaml
steps:
- name: Set up butler
uses: jdno/setup-butler@v1
- name: Print butler version
run: butler -V
```
## Configuration
The behavior of `setup-butler` can be customized with these settings.
| Parameter | Description | Default |
| --------- | --------------------- | -------- |
| `version` | The version of butler | `latest` |
### `version`
The `version` parameter can be used to set the version of butler that gets
installed.
```yaml
steps:
- name: Set up butler
uses: jdno/setup-butler@v1
with:
version: 15.20.0
```
If the `version` is not specified, the latest version will be installed.
## Code of Conduct
👋 This is a welcoming and inclusive project. Be nice and follow our
[code of conduct](./CODE_OF_CONDUCT.md).
## Acknowledgments
The implementation of this action is inspired by
[actions/setup-node](https://github.com/actions/setup-node) and
[bufbuild/buf-setup-action](https://github.com/bufbuild/buf-setup-action).
## License
This project is released under the terms of the [MIT License](./LICENSE).
[butler]: https://itch.io/docs/butler/
[itch.io]: https://itch.io/