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: about 2 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 (10 months ago)
• Default Branch: master
• Last Pushed: 2024-10-31T14:29:37.000Z (2 months ago)
• Last Synced: 2024-10-31T15:30:51.189Z (2 months ago)
• Topics: action, actions, butler, cli, github, github-action, github-actions, itchio, workflow
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/setup-butler
• Size: 933 KB
• 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

[![version](https://badgen.net/github/release/remarkablegames/setup-butler)](https://github.com/remarkablegames/setup-butler/releases)

[![build](https://github.com/remarkablegames/setup-butler/actions/workflows/build.yml/badge.svg)](https://github.com/remarkablegames/setup-butler/actions/workflows/build.yml)

[![codecov](https://codecov.io/gh/remarkablegames/setup-butler/graph/badge.svg?token=AAbBz3SIPn)](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@v1

      - 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 }}

```

The `BUTLER_API_KEY` is your [itch.io API key](https://itch.io/user/settings/api-keys).

## Usage

See [action.yml](action.yml)

**Basic:**

```yaml

- uses: remarkablegames/setup-butler@v1

```

## Inputs

### `butler-version`

**Optional**: The CLI [version](https://broth.itch.ovh/butler). Defaults to `LATEST`:

```yaml

- uses: remarkablegames/setup-butler@v1

  with:

    butler-version: LATEST

```

### `cli-name`

**Optional**: The CLI name. Defaults to `butler`:

```yaml

- uses: remarkablegames/setup-butler@v1

  with:

    cli-name: butler

```

## Examples

- [remarkablegames/phaser-template](https://github.com/remarkablegames/phaser-template/blob/master/.github/workflows/release-please.yml)

- [remarkablegames/renpy-template](https://github.com/remarkablegames/renpy-template/blob/master/.github/workflows/release-please.yml)

## Contributions

Contributions are welcome!

## License

[MIT](LICENSE)