Merge pull request #14 from jaychang99/release/v0.2.1-beta

Release/v0.2.1 beta

Author: jaychang99

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+# 0.2.1-beta (July 1, 2024)
+
+Below is a list of all new features, APIs, deprecations, and breaking changes.
+
+## New Features
+
+-
+
+## Improvements
+
+-
+
+## Other Changes
+
+-
+
+## Bug Fixes
+
+-

action.yml

@@ -10,9 +10,37 @@ branding:
 # Define your inputs here.
 inputs:
   milliseconds:
-    description: 'Your input description here'
+    description: 'The number of milliseconds to wait before the action starts. '
     required: true
     default: '1000'
+  slack_enabled:
+    description: 'Enable Slack notifications'
+    required: false
+    default: 'false'
+  slack_channel_id:
+    description: 'The Slack channel ID to send notifications to'
+  slack_access_token:
+    description:
+      'The Slack access token that has the necessary permissions to send
+      messages to the channel'
+  locale:
+    description: 'The locale to use for the action'
+    required: false
+    default: 'en-us'
+  member_id_list_to_mention:
+    description:
+      'A list of member IDs to mention in the Slack message, comma separated'
+  api_documentation_url:
+    description: 'The URL to the API documentation'
+    required: false
+  openapi_file_path:
+    description: 'The path to the OpenAPI file'
+    required: false
+    default: 'openapi.json'
+  head_commit_message:
+    description: 'The message of the head commit'
+  head_commit_sha:
+    description: 'The SHA of the head commit'
 
 # Define your outputs here.
 outputs:

badges/coverage.svg

@@ -39,6 +39,11 @@ export interface GithubInput {
    */
   headCommitMessage?: string
 
+  /**
+   * The sha of the last commit which triggered the action
+   */
+  headCommitSha?: string
+
   /**
    * URL of the api documentation - Optional
    */

dist/index.js

@@ -1,8 +1,14 @@
 import { execSync } from 'child_process'
 import { readFileSync } from 'fs'
 
-export function getFileFromBranch(branch: string, filePath: string): Buffer {
+export function getFileFromBranch(
+  branch: string,
+  filePath: string,
+  offsetFromHead?: number
+): Buffer {
+  const offset = offsetFromHead ? `~${offsetFromHead}` : ''
+
   execSync(`git fetch origin ${branch}`)
-  execSync(`git checkout FETCH_HEAD -- ${filePath}`)
+  execSync(`git checkout FETCH_HEAD${offset} -- ${filePath}`)
   return readFileSync(filePath)
 }

dist/index.js.map

@@ -99,23 +99,35 @@ export function validateInputAndSetConfig(): Config {
     const baseCommittish = isOnPullRequest
       ? // eslint-disable-next-line  @typescript-eslint/no-non-null-assertion
         process.env.GITHUB_BASE_REF!
-      : `${headCommittish}~1`
+      : headCommittish
 
+    // core.getInput() always returns a string, so nullish coalescing operator does not work.
     const openapiFilePath =
-      core.getInput('openapi_file_path') ?? DEFAULT_OPENAPI_FILE_PATH
+      core.getInput('openapi_file_path') === ''
+        ? DEFAULT_OPENAPI_FILE_PATH
+        : core.getInput('openapi_file_path')
 
     baseFile = JSON.parse(
-      getFileFromBranch(baseCommittish, openapiFilePath).toString()
+      getFileFromBranch(
+        baseCommittish,
+        openapiFilePath,
+        isOnPullRequest ? undefined : 1
+      ).toString()
     )
     headFile = JSON.parse(
       getFileFromBranch(headCommittish, openapiFilePath).toString()
     )
   }
 
+  const sha =
+    core.getInput('head_commit_sha') === ''
+      ? MOCKUP_SHA
+      : core.getInput('head_commit_sha')
+
   const githubConfig: Config['githubConfig'] = {
     repository: process.env.GITHUB_REPOSITORY ?? MOCKUP_REPOSITORY,
     headCommitInfo: {
-      sha: process.env.GITHUB_SHA ?? MOCKUP_SHA,
+      sha,
       message:
         core.getInput('head_commit_message') === ''
           ? MOCKUP_MESSAGE