{"id":20110424,"url":"https://github.com/remarkablegames/setup-butler","last_synced_at":"2026-01-28T22:09:37.508Z","repository":{"id":224255369,"uuid":"762828273","full_name":"remarkablegames/setup-butler","owner":"remarkablegames","description":"🎩 Set up GitHub Actions workflow with itch.io butler","archived":false,"fork":false,"pushed_at":"2025-05-02T14:43:00.000Z","size":1582,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-05-02T15:45:00.437Z","etag":null,"topics":["action","actions","butler","cli","github","github-action","github-actions","itchio","workflow"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/setup-butler","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/remarkablegames.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-02-24T19:57:14.000Z","updated_at":"2025-05-02T14:43:03.000Z","dependencies_parsed_at":"2024-12-04T16:18:48.795Z","dependency_job_id":"30543872-b770-4d3d-90be-9f4369ce3b16","html_url":"https://github.com/remarkablegames/setup-butler","commit_stats":null,"previous_names":["remarkablegames/setup-butler"],"tags_count":8,"template":false,"template_full_name":"remarkablemark/github-actions-setup-cli-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkablegames%2Fsetup-butler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkablegames%2Fsetup-butler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkablegames%2Fsetup-butler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkablegames%2Fsetup-butler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/remarkablegames","download_url":"https://codeload.github.com/remarkablegames/setup-butler/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252666078,"owners_count":21785192,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["action","actions","butler","cli","github","github-action","github-actions","itchio","workflow"],"created_at":"2024-11-13T18:11:45.769Z","updated_at":"2026-01-28T22:09:37.502Z","avatar_url":"https://github.com/remarkablegames.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"itch.io\" height=\"150\" src=\"https://raw.githubusercontent.com/remarkablegames/setup-butler/master/itchio-logo.svg\"\u003e\n\u003c/p\u003e\n\n# setup-butler\n\n[![version](https://img.shields.io/github/release/remarkablegames/setup-butler)](https://github.com/remarkablegames/setup-butler/releases)\n[![build](https://github.com/remarkablegames/setup-butler/actions/workflows/build.yml/badge.svg)](https://github.com/remarkablegames/setup-butler/actions/workflows/build.yml)\n[![codecov](https://codecov.io/gh/remarkablegames/setup-butler/graph/badge.svg?token=AAbBz3SIPn)](https://codecov.io/gh/remarkablegames/setup-butler)\n\n🎩 Set up your GitHub Actions workflow with [itch.io](https://itch.io/) [butler](https://itch.io/docs/butler/).\n\n## Quick Start\n\n```yaml\nname: Upload to itch.io\non: push\njobs:\n  itchio-upload:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Setup butler\n        uses: remarkablegames/setup-butler@v2\n\n      # https://itch.io/docs/butler/pushing.html\n      - name: Upload to itch.io\n        run: butler push directory user/game:channel\n        env:\n          BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }}\n```\n\nThe `BUTLER_API_KEY` is your [itch.io API key](https://itch.io/user/settings/api-keys).\n\n## Usage\n\nSet up butler CLI:\n\n```yaml\n- uses: remarkablegames/setup-butler@v2\n```\n\nSee [action.yml](action.yml)\n\n## Inputs\n\n### `butler-version`\n\n**Optional**: The CLI [version](https://broth.itch.zone/butler). Defaults to `LATEST`:\n\n```yaml\n- uses: remarkablegames/setup-butler@v2\n  with:\n    butler-version: LATEST\n```\n\n### `cli-name`\n\n**Optional**: The CLI name. Defaults to `butler`:\n\n```yaml\n- uses: remarkablegames/setup-butler@v2\n  with:\n    cli-name: butler\n```\n\n## Examples\n\n- [phaser-template](https://github.com/remarkablegames/phaser-template/blob/master/.github/workflows/release-please.yml)\n- [renpy-template](https://github.com/remarkablegames/renpy-template/blob/master/.github/workflows/release-please.yml)\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremarkablegames%2Fsetup-butler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fremarkablegames%2Fsetup-butler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremarkablegames%2Fsetup-butler/lists"}