Merge pull request #65 from roots/support-repo-token-input

Support repo-token input

Author: swalkinshaw

.github/workflows/test.yml

@@ -21,6 +21,7 @@ jobs:
         ansible-vault-password: fake
         auto-init: false
         galaxy-install: false
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
   test-with-trellis:
     runs-on: ubuntu-latest
     steps:
@@ -34,6 +35,7 @@ jobs:
     - uses: ./
       with:
         ansible-vault-password: fake
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
   test-with-trellis-no-galaxy:
     runs-on: ubuntu-latest
     steps:
@@ -48,6 +50,7 @@ jobs:
       with:
         ansible-vault-password: fake
         galaxy-install: false
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
   test-with-trellis-no-auto-init:
     runs-on: ubuntu-latest
     steps:
@@ -62,6 +65,7 @@ jobs:
       with:
         ansible-vault-password: fake
         auto-init: false
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
   test-with-trellis-no-cache-virtualenv:
     runs-on: ubuntu-latest
     steps:
@@ -76,3 +80,19 @@ jobs:
       with:
         ansible-vault-password: fake
         cache-virtualenv: false
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+  test-no-repo-token:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 16.x
+    - run: mkdir trellis
+    - uses: ./
+      with:
+        ansible-vault-password: fake
+        auto-init: false
+        galaxy-install: false

README.md

@@ -20,6 +20,7 @@ steps:
 - uses: roots/setup-trellis-cli@v1
   with:
     ansible-vault-password: ${{ secrets.ANSIBLE_VAULT_PASSWORD }}
+    repo-token: ${{ secrets.GITHUB_TOKEN }}
 - run: trellis deploy production
 ```
 
@@ -46,6 +47,13 @@ gh secret set ANSIBLE_VAULT_PASSWORD -b $(cat trellis/.vault_pass)
 Note: this is a required input even if you don't use Ansible Vault. Just set
 this to any random placeholder string.
 
+#### `repo-token`
+Optionally set the GitHub token for API authorization. Setting this token will avoid any potential API rate limits.
+
+The best option is to set this to the default token secret which GitHub automatically sets: `secrets.GITHUB_TOKEN`.
+
+See https://docs.github.com/en/actions/security-guides/automatic-token-authentication
+
 #### `auto-init`
 Whether to automatically run the `trellis init` command after install.
 

action.yml

@@ -20,6 +20,9 @@ inputs:
     description: 'Whether to automatically run `trellix galaxy install` (default: true).'
     required: false
     default: true
+  repo-token:
+    description: 'GitHub repository access token used for API authentication. Set this to avoid API rate limits.'
+    required: false
   trellis-directory:
     description: 'Path to Trellis project directory'
     required: false

dist/index.js

@@ -20,6 +20,7 @@ jobs:
         ssh-private-key: ${{ secrets.TRELLIS_DEPLOY_SSH_PRIVATE_KEY }}
     - uses: roots/setup-trellis-cli@v1
       with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
         ansible-vault-password: ${{ secrets.ANSIBLE_VAULT_PASSWORD }}
     - name: Deploy
       run: trellis deploy production

dist/index.js.map

@@ -32,6 +32,7 @@ jobs:
         ssh-private-key: ${{ secrets.TRELLIS_DEPLOY_SSH_PRIVATE_KEY }}
     - uses: roots/setup-trellis-cli@v1
       with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
         ansible-vault-password: ${{ secrets.ANSIBLE_VAULT_PASSWORD }}
     - name: Deploy
       run: trellis deploy production

examples/basic.yml

@@ -25,6 +25,7 @@ jobs:
         ssh-private-key: ${{ secrets.TRELLIS_DEPLOY_SSH_PRIVATE_KEY }}
     - uses: roots/setup-trellis-cli@v1
       with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
         ansible-vault-password: ${{ secrets.ANSIBLE_VAULT_PASSWORD }}
     - name: Deploy
       run: trellis deploy production

examples/multi-repo.yml

@@ -14,7 +14,7 @@ function isExactCacheKeyMatch(key, cacheKey) {
   return !!(cacheKey && cacheKey.localeCompare(key, undefined, { sensitivity: "accent" }) === 0);
 }
 
-async function getRelease(version) {
+async function getRelease(version, token) {
   let osPlatform = os.platform();
   const platformMappings = {
     'win32': 'windows'
@@ -29,10 +29,11 @@ async function getRelease(version) {
   osArch = archMappings[osArch] || osArch;
 
   core.debug(`Finding release for ${version} (${osPlatform}_${osArch})`);
-  const release = await fetchRelease(version);
+  const release = await fetchRelease(version, token);
 
   if (!release.name) {
-    core.info(`API response: ${JSON.stringify(release)}`);
+    core.warning(`API response: ${JSON.stringify(release)}`);
+    core.warning(`If you are hitting API rate limits, see the README for instructions on using a GitHub token.`);
     throw new Error(`No trellis-cli release found for version ${version}`);
   }
 
@@ -54,12 +55,14 @@ async function getRelease(version) {
   }
 }
 
-async function fetchRelease(version) {
+async function fetchRelease(version, token) {
   const client = new http.HttpClient('setup-trellis-cli-client');
 
   let headers = {};
-  if (process.env.GITHUB_TOKEN) {
-    headers['authorization'] = `Bearer ${process.env.GITHUB_TOKEN}`;
+  if (token !== '') {
+    headers['authorization'] = `Bearer ${token}`;
+  } else {
+    core.warning(`No repo-token provided. We recommend setting one to avoid rate limiting. See the README for instructions.`);
   }
 
   let url = null;
@@ -158,9 +161,10 @@ async function run() {
     const galaxyInstall = core.getBooleanInput('galaxy-install');
     const trellisPath = core.getInput('trellis-directory') || 'trellis';
     const version = core.getInput('version') || 'latest';
+    const token = core.getInput('repo-token');
 
     await core.group('Install trellis-cli', async () => {
-      const release = await getRelease(version);
+      const release = await getRelease(version, token);
       const cliPath = await downloadRelease(release);
       core.addPath(cliPath);
       core.debug(`Added ${cliPath} to PATH`);