https://github.com/buildalon/setup-butler

A Github Action to setup the butler command line tool for itch.io content authoring
https://github.com/buildalon/setup-butler

actions butler game-ci game-development github github-actions github-actions-tool itch itch-io itchio tool-cache

Last synced: 5 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/buildalon/setup-butler
• Owner: buildalon
• License: mit
• Created: 2024-12-04T16:35:30.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2025-01-22T02:40:34.000Z (5 months ago)
• Last Synced: 2025-01-22T03:26:23.106Z (5 months ago)
• Topics: actions, butler, game-ci, game-development, github, github-actions, github-actions-tool, itch, itch-io, itchio, tool-cache
• Language: TypeScript
• Homepage: https://github.com/itchio/butler
• Size: 400 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# setup-butler

[![Discord](https://img.shields.io/discord/939721153688264824.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/VM9cWJ9rjH) [![marketplace](https://img.shields.io/static/v1?label=&labelColor=505050&message=Buildalon%20Actions&color=FF1E6F&logo=github-actions&logoColor=0076D6)](https://github.com/marketplace?query=buildalon) [![validate](https://github.com/buildalon/setup-butler/actions/workflows/validate.yml/badge.svg?branch=main)](https://github.com/buildalon/setup-butler/actions/workflows/validate.yml)

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: buildalon/setup-butler@v1

        with:

          api-key: ${{ secrets.BUTLER_API_KEY }}

      # run butler commands

      - name: Upload to itch.io

        # https://itch.io/docs/butler/pushing.html

        run: butler push directory user/game:channel

        env:

          BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }}

```

### 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.