Merge pull request #19 from hey-api/feat/default-branch

feat: send default branch

Author: mrlubos

.github/workflows/ci.yaml

@@ -21,14 +21,18 @@ jobs:
         id: upload-json-openapi-spec
         uses: ./
         with:
-          api-key: ${{ secrets.HEY_API_TOKEN }}
           dry-run: true
           path-to-file: ./openapi.json
+        env:
+          API_KEY: ${{ secrets.HEY_API_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Upload YAML OpenAPI spec
         id: upload-yaml-openapi-spec
         uses: ./
         with:
-          api-key: ${{ secrets.HEY_API_TOKEN }}
           dry-run: true
           path-to-file: ./openapi.yaml
+        env:
+          API_KEY: ${{ secrets.HEY_API_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -31,9 +31,11 @@ jobs:
       - name: Upload OpenAPI spec
         uses: hey-api/[email protected]
         with:
-          api-key: ${{ secrets.HEY_API_TOKEN }}
           path-to-file: path/to/openapi.json
           tags: optional,custom,tags
+        env:
+          API_KEY: ${{ secrets.HEY_API_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 The example above will upload your OpenAPI specification to Hey API on every
@@ -44,13 +46,6 @@ pull request and push to the `main` branch.
 To successfully upload an OpenAPI specification, you need to provide the
 following inputs (see `with` in the example above)
 
-### `api-key`
-
-This is the project API key you obtained from
-[Hey API](https://app.heyapi.dev/).
-
-> Note: Personal API keys can't be used to upload specifications.
-
 ### `path-to-file`
 
 A relative path to your OpenAPI file within the repository. Note that you might
@@ -62,6 +57,23 @@ need an additional step in your GitHub workflow to generate this file (see
 A comma-separated string value representing any custom tags you wish to add to
 your OpenAPI specification.
 
+## Environment Variables
+
+In addition to the required `path-to-file` input, you must provide the following
+environment variables.
+
+### `API_KEY`
+
+This is the project API key you obtained from
+[Hey API](https://app.heyapi.dev/).
+
+> Note: Personal API keys can't be used to upload specifications.
+
+### `GITHUB_TOKEN`
+
+This variable will be available inside your workflow by default. It's used to
+fetch information about your repository, i.e. default branch.
+
 ## Next Steps
 
 Please follow the

action.yml

@@ -4,9 +4,6 @@ branding:
   icon: file-plus
 description: Upload your OpenAPI specification to Hey API
 inputs:
-  api-key:
-    description: Hey API service token
-    required: true
   base-url:
     description: Configure Hey API server URL
     required: false

dist/index.js

@@ -6,10 +6,15 @@ import { upload } from './upload'
  * @returns {Promise<void>} Resolves when the action is complete.
  */
 export async function run(): Promise<void> {
+  if (!process.env.API_KEY) {
+    core.setFailed('The API_KEY environment variable is required.')
+  }
+
+  if (!process.env.GITHUB_TOKEN) {
+    core.setFailed('The GITHUB_TOKEN environment variable is required.')
+  }
+
   try {
-    const apiKey: string = core.getInput('api-key', {
-      required: true
-    })
     const baseUrl: string = core.getInput('base-url', {
       required: false
     })
@@ -27,7 +32,6 @@ export async function run(): Promise<void> {
     core.debug(`Path to OpenAPI: ${pathToFile}`)
     core.debug(`Upload started: ${new Date().toTimeString()}`)
     await upload({
-      apiKey,
       baseUrl,
       dryRun,
       pathToFile,

dist/index.js.map

@@ -6,16 +6,11 @@ import { postV1Specifications } from './client'
  * Read and upload the provided OpenAPI specification to Hey API.
  */
 export async function upload({
-  apiKey,
   baseUrl,
   dryRun,
   pathToFile,
   tags
 }: {
-  /**
-   * Hey API token.
-   */
-  apiKey: string
   /**
    * Custom service url.
    */
@@ -58,8 +53,23 @@ export async function upload({
         : 'application/json'
   })
 
+  const repository = process.env.GITHUB_REPOSITORY
+
+  const response = await fetch(`https://api.github.com/repos/${repository}`, {
+    method: 'GET',
+    headers: {
+      Authorization: `Bearer ${process.env.GITHUB_TOKEN}`
+    }
+  })
+
+  let defaultBranch
+  if (response.ok) {
+    const repo = await response.json()
+    defaultBranch = repo.default_branch
+  }
+
   const { error } = await postV1Specifications({
-    auth: apiKey,
+    auth: process.env.API_KEY,
     baseUrl: baseUrl || 'https://api.heyapi.dev',
     body: {
       actor: process.env.GITHUB_ACTOR,
@@ -68,12 +78,14 @@ export async function upload({
       branch_base: process.env.GITHUB_BASE_REF,
       ci_platform: 'github',
       commit_sha: commitSha,
+      // @ts-expect-error
+      default_branch: defaultBranch,
       dry_run: dryRun,
       event_name: process.env.GITHUB_EVENT_NAME,
       job: process.env.GITHUB_JOB,
       ref: process.env.GITHUB_REF,
       ref_type: process.env.GITHUB_REF_TYPE,
-      repository: process.env.GITHUB_REPOSITORY,
+      repository,
       run_id: process.env.GITHUB_RUN_ID,
       run_number: process.env.GITHUB_RUN_NUMBER,
       specification,