Remove the need for specifying GITHUB_TOKEN env (#18)

Signed-off-by: peterdeme <snypox@gmail.com>
spacelift-io · Feb 21, 2024 · f67ebcc · f67ebcc
1 parent d058696
commit f67ebcc
Show file tree

Hide file tree

Showing 7 changed files with 513 additions and 24,540 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -22,13 +22,8 @@ jobs:
       - name: Checkout
         uses: actions/checkout@main
 
-      - name: Install packages
-        run: npm ci
-
       - name: Test installing spacectl
-        run: node .
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: ./
 
       - name: Test if spacectl works
         run: spacectl --version
diff --git a/README.md b/README.md
@@ -6,14 +6,12 @@ This is a simple GitHub Action to install [spacectl](https://github.com/spacelif
 
 ## ✨ Usage
 
-`GITHUB_TOKEN` environment variable is a **must** because we're using it internally to list all releases of `spacectl` to find the latest one.
+Note that the action queries the GitHub API to list the available releases of `spacectl` so it needs a GitHub token. By default it uses `${{ github.token }}` but you can override it by setting the `github-token` input.
 
 ```yaml
 steps:
   - name: Install spacectl
-    uses: spacelift-io/setup-spacectl@main
-    env:
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    uses: spacelift-io/setup-spacectl@v1
 
   - name: Deploy infrastructure
     env:
@@ -28,18 +26,17 @@ You can optionally provide a specific version:
 ```yaml
 steps:
   - name: Install spacectl
-    uses: spacelift-io/setup-spacectl@main
-    env:
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    uses: spacelift-io/setup-spacectl@v1
     with:
       version: v0.18.0
 ```
 
 ### Inputs
 
-| Name      | Description                                                                                                   | Default  |
-| --------- | ------------------------------------------------------------------------------------------------------------- | -------- |
-| `version` | Which version of `spacectl` to install. If not specified, the latest version will be installed (recommended). | `latest` |
+| Name           | Description                                                                                                   | Default               |
+| -------------- | ------------------------------------------------------------------------------------------------------------- | --------------------- |
+| `version`      | Which version of `spacectl` to install. If not specified, the latest version will be installed (recommended). | `latest`              |
+| `github-token` | The GitHub token to use for querying the GitHub API.                                                          | `${{ github.token }}` |
 
 ### Outputs
 

diff --git a/action.yml b/action.yml
@@ -8,6 +8,10 @@ inputs:
   version:
     description: The version of Spacectl to install. Defaults to latest.
     default: latest
+  github-token:
+    description: GitHub token to use for querying the GitHub API.
+    required: false
+    default: ${{ github.token }}
 
 runs:
   using: node20