setup-butler@v1.0.0

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @buildalon/buildalon

.github/workflows/validate.yml

@@ -0,0 +1,29 @@
+name: validate
+on:
+  push:
+    branches:
+      - 'main'
+  pull_request:
+    branches:
+      - '*'
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  validate:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      # download and setup butler
+      - uses: ./
+        name: buildalon/setup-butler
+        with:
+          api-key: ${{ secrets.BUTLER_API_KEY }}
+      # run butler
+      - run: butler --version

.gitignore

@@ -0,0 +1 @@
+node_modules

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Buildalon: Automate Unity
+Copyright (c) 2024 Virtual Maker Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,44 @@
 # setup-butler
-A Github Action to setup the butler command line tool for itch.io content authoring.
+
+[![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.

action.yml

@@ -0,0 +1,21 @@
+name: 'Buildalon Setup Butler'
+description: A Github Action to setup the butler command line tools for itch.io content authoring.
+branding:
+  color: 'red'
+  icon: 'terminal'
+inputs:
+  api-key:
+    description: 'The API key for your itch.io account.'
+    required: true
+  version:
+    description: 'The version of the butler CLI to install.'
+    required: false
+    default: 'latest'
+  self-update:
+    description: 'Whether to update the butler CLI to the latest version.'
+    required: false
+    default: 'true'
+runs:
+  using: 'node20'
+  main: 'dist/index.js'
+  post: 'dist/index.js'