feat: use GitHub token for release resolution

Add optional token input and fallback to GITHUB_TOKEN so release lookups are authenticated, reducing rate-limit failures in GitHub Actions.

Made-with: Cursor

Author: jbrand-dsp

.github/workflows/bruin.yml

@@ -14,7 +14,6 @@ jobs:
     steps:
       - name: Setup repo
         uses: actions/checkout@v4
-      # Installs latest
       - uses: bruin-data/bruin-setup-action@main
       - run: bruin init default
       - run: bruin validate ./bruin-pipeline/

README.md

@@ -27,6 +27,7 @@ You can configure `setup-bruin` with these parameters:
 | Parameter      | Description                                        | Default            |
 |:---------------|:---------------------------------------------------|:-------------------|
 | `version`      | The version of the [`bruin`](https://github.com/bruin-data/bruin)  to install | [`latest`](https://github.com/bruin-data/bruin/releases) |
+| `token`        | GitHub token for API requests (avoids rate limits). When omitted, the workflow `GITHUB_TOKEN` is used automatically. | `GITHUB_TOKEN` (in Actions) |
 
 > These parameters are derived from [`action.yml`](./action.yml). <br>
 #### Version

action.yml

@@ -9,6 +9,12 @@ inputs:
     description: The version of bruin to set up.
     required: false
     default: 'latest'
+  token:
+    description: >
+      GitHub token for API requests (e.g. to list releases and resolve download URLs).
+      Defaults to the workflow GITHUB_TOKEN when not set. Use this to avoid API rate limits.
+    required: false
+    default: ''
 runs:
   using: "node20"
   main: "./dist/main.js"

dist/main.js

@@ -8,6 +8,7 @@ import { HttpsProxyAgent } from "https-proxy-agent";
 
 export async function getBruin(
   version: string,
+  token?: string,
 ): Promise<string | Error> {
   const binaryPath = tc.find("bruin", version, os.arch());
   if (binaryPath !== "") {
@@ -16,7 +17,7 @@ export async function getBruin(
   }
 
   core.info(`Resolving the download URL for the current platform...`);
-  const downloadURL = await getDownloadURL(version);
+  const downloadURL = await getDownloadURL(version, token);
 
   if (isError(downloadURL)) {
     return downloadURL;
@@ -72,7 +73,8 @@ export async function getBruin(
 // getDownloadURL resolves Bruin's Github download URL for the
 // current architecture and platform.
 async function getDownloadURL(
-  version: string
+  version: string,
+  token?: string,
 ): Promise<string | Error> {
   let architecture = "";
   switch (os.arch()) {
@@ -123,6 +125,7 @@ async function getDownloadURL(
     ? new HttpsProxyAgent(process.env.http_proxy)
     : undefined;
   const octokit = new Octokit({
+    auth: token,
     request: {
       agent: requestAgent,
     },

dist/main.js.map

@@ -35,8 +35,11 @@ export async function runSetup(): Promise<null | Error> {
     };
   }
 
+  // Use token input or fall back to GITHUB_TOKEN (provided automatically in Actions)
+  const token = core.getInput("token") || process.env.GITHUB_TOKEN || undefined;
+
   core.info(`Setting up bruin version "${version}"`);
-  const installDir = await getBruin(version);
+  const installDir = await getBruin(version, token);
   if (isError(installDir)) {
     return installDir;
   }