Implement authentication for github api

.github/workflows/test.yml

@@ -15,6 +15,8 @@ jobs:
           npm install
       - run: |
           npm run all
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   test: # make sure the action works on a clean machine without building
     runs-on: ubuntu-latest
     steps:
@@ -23,6 +25,7 @@ jobs:
         with:
           output: swagger-ui-output
           spec-url: https://petstore.swagger.io/v2/swagger.json
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "Verify swagger-ui was created"
         run: |
           test -f swagger-ui-output/index.html

README.md

@@ -19,6 +19,8 @@ In this case, it is your responsibility to copy required files such as the OpenA
 The output directory of the generated Swagger UI must be set with the `output` argument of the Action.
 Optionally the Swagger UI version can be set with the `version` input, it accepts semver ranges.
 
+The `GITHUB_TOKEN` secret must be provided to the action. It is used to query the Github api and download the release files of Swagger UI.
+
 ### Example
 This Action only generates the Swagger UI.
 For example, to deploy it to GitHub Pages another Action is required.
@@ -30,6 +32,7 @@ Example steps from a workflow to generate and deploy Swagger UI to GitHub Pages:
         with:
           output: swagger-ui
           spec-file: openapi.json
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:

package.json

@@ -30,6 +30,7 @@
     "@actions/exec": "^1.1.1",
     "@actions/http-client": "^2.1.0",
     "@actions/io": "^1.1.3",
+    "@octokit/auth-action": "^4.0.0",
     "@octokit/rest": "^19.0.7",
     "semver": "^7.5.4"
   },

src/swagger-ui-action.ts

@@ -5,6 +5,7 @@ import {basename, join} from 'path';
 import {Octokit} from '@octokit/rest';
 import {exec} from '@actions/exec';
 import {satisfies} from 'semver';
+import {createActionAuth} from '@octokit/auth-action';
 
 export async function getBasenameInArchive(archive: string): Promise<string> {
   let filesList = '';
@@ -188,7 +189,9 @@ export function invalidSwaggerUiConfig(
 export async function getSwaggerUIRelease({
   swaggerUIVersion
 }: Config): Promise<{tag_name: string; tarball_url: string}> {
-  const octokit = new Octokit();
+  const octokit = new Octokit({
+    authStrategy: createActionAuth
+  });
   const foundReleases = await octokit.paginate(
     octokit.rest.repos.listReleases,
     {