add ref inputs (#4)

Author: shiyuhang0

README.md

@@ -19,6 +19,7 @@ with:
 
 The action supports the following inputs:
 - token - (required) The GitHub token to use for making API requests. Typically, this would be set to ${{ secrets.GITHUB_TOKEN }}.
+- ref - (optional) The git ref of the commit you want to check. Default is `github.event.pull_request.head.sha`.
 - public-key - (required) The public key of TiDB Cloud api. Generate it from [TiDB Cloud](https://tidbcloud.com/).
 - private-key - (required) The private key of TiDB Cloud api. Generate it from [TiDB Cloud](https://tidbcloud.com/).
 - interval-seconds - (optional) The interval seconds to check the status of TiDB Cloud Branch check. Default is 10.

action.yml

@@ -8,6 +8,8 @@ inputs:
   token:
     description: 'The GitHub token to use for making API requests.'
     required: true
+  ref:
+    description: 'The git ref of the commit you want to check.'
   timeout-seconds:
     description: 'The number of seconds to wait for the branch ready.'
     default: '300'

dist/index.js

@@ -5,6 +5,7 @@ import {sqluser} from './sqluser'
 
 async function run(): Promise<void> {
   const token = core.getInput('token', {required: true})
+  let gitRef = core.getInput('ref')
   const publicKey = core.getInput('public-key', {required: true})
   const privateKey = core.getInput('private-key', {required: true})
   // defensive programming
@@ -18,8 +19,13 @@ async function run(): Promise<void> {
     throw new Error('privateKey is empty')
   }
   try {
-    if (context.payload.pull_request === undefined) {
-      throw new Error('This action only works on pull_request events now')
+    if (gitRef === '' || gitRef === undefined) {
+      if (context.payload.pull_request === undefined) {
+        throw new Error(
+          'This action only works on pull_request events if you do not specify ref'
+        )
+      }
+      gitRef = context.payload.pull_request.head.sha
     }
     const result = await poll({
       client: getOctokit(token),
@@ -28,7 +34,7 @@ async function run(): Promise<void> {
       checkName: 'TiDB Cloud Branch',
       owner: context.repo.owner,
       repo: context.repo.repo,
-      ref: context.payload.pull_request.head.sha,
+      ref: gitRef,
 
       timeoutSeconds: parseInt(core.getInput('timeout-seconds')),
       intervalSeconds: parseInt(core.getInput('interval-seconds'))