-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update butler version. update README.md
- Loading branch information
Showing
2 changed files
with
55 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,54 @@ | ||
# Itch.io - Publish GitHub Action | ||
# Itch.io - Publish GitHub Action | ||
|
||
Helps you publish new releases to itch.io using butler. | ||
|
||
## Inputs | ||
|
||
| Name | Required | Description | | ||
|---------|----------|---------------------------------------------------------------------------------------------------| | ||
| butlerAPIKey | Yes | The secret API Key you can get by following these instructions: https://itch.io/docs/butler/login.html#running-butler-from-ci-builds-travis-ci-gitlab-ci-etc | ||
| gameData | Yes | Directory or .zip file of the game data. Zip files are slower to upload.| | ||
| itchUsername | Yes | username of the game owner. e.g. in `kikimora.itch.io/wizards-way-out` this would be `kikimora`| | ||
| itchGameId | Yes | id of the game. e.g. in `kikimora.itch.io/wizards-way-out` this would be `wizards-way-out` | ||
| buildChannel | Yes | Channel name of the game: https://itch.io/docs/butler/pushing.html#channel-names| | ||
| buildNumber | No | Use to supply your own build version instead of using itch's versioning| | ||
| buildNumberFile | No | use to supply your own build version instead of using itch's versioning. The file should contain a single line with the version or build number, in UTF-8 without BOM| | ||
|
||
## Example usage | ||
|
||
### Workflow configuration | ||
|
||
```yaml | ||
name: Deploy | ||
|
||
on: push | ||
env: | ||
ITCH_USERNAME: my-username | ||
ITCH_GAME_ID: my-game-id | ||
jobs: | ||
deploy: | ||
name: Upload to Itch | ||
runs-on: ubuntu-latest | ||
strategy: | ||
fail-fast: true | ||
matrix: | ||
channel: | ||
- windows | ||
- webgl | ||
runs-on: ubuntu-latest | ||
name: Deploy - Itch.io ${{ matrix.template }} | ||
steps: | ||
- uses: actions/[email protected] | ||
with: | ||
name: ${{ matrix.channel }} | ||
path: build/${{ matrix.channel }} | ||
- uses: KikimoraGames/[email protected] | ||
with: | ||
butlerApiKey: ${{secrets.BUTLER_API_KEY}} | ||
gameData: ./build/${{ matrix.template }} | ||
itchUsername: ${{env.ITCH_USERNAME}} | ||
itchGameId: ${{ env.ITCH_GAME_ID }} | ||
buildChannel: ${{ matrix.channel }} | ||
buildNumber: ${{ needs.version.outputs.version_hash }} | ||
|
||
``` |