setup-butler@v1.0.0 (#1)

- Initial Release! 🎉🚀

.github/workflows/validate.yml

@@ -17,7 +17,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [macos-latest, windows-latest, ubuntu-latest]
     steps:
       - uses: actions/checkout@v4
-      - run: echo "hello world"
+      # download and setup butler
+      - uses: ./
+        name: RageAgainstThePixel/setup-butler
+        with:
+          api-key: ${{ secrets.BUTLER_API_KEY }}
+      # run butler
+      - run: butler --version

README.md

@@ -1,20 +1,38 @@
-# github-action-template
+# setup-butler
 
-A GitHub Actions template repository for TypeScript based Actions.
+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
-steps:
-  - uses: RageAgainstThePixel/github-action-template@v1
+jobs:
+  validate:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+    steps:
+      # download and setup butler
+      - uses: RageAgainstThePixel/setup-butler@v1
+        with:
+          api-key: ${{ secrets.BUTLER_API_KEY }}
+      # run butler
+      - run: butler --version
 ```
 
 ### 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

@@ -1,8 +1,21 @@
-name: github-action-template
-description: 'A GitHub Actions template repository for JavaScript based Actions'
-# inputs:
-# outputs:
+name: setup-butler
+description: A Github Action to setup the butler command line tools for itch.io content authoring.
+branding:
+  color: 'blue'
+  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'
+  post: 'dist/index.js'