Add merge_group support

Author: Sean P. Kane

Makefile

@@ -5,11 +5,11 @@ clean:
 	npm run clean
 
 .PHONY: install
-install: 
+install:
 	npm install
 
 .PHONY: build
-build: 
+build:
 	npm run build
 
 .PHONY: test
@@ -21,12 +21,12 @@ coverage: build
 	npm run coverage
 
 .PHONY: all
-all: 
+all:
 	npm run all
 
 .PHONY: release
 release: all
-	npm prune --production 
+	npm prune --production
 
 .PHONY: semantic-release
 semantic-release:
@@ -58,4 +58,4 @@ tag-major: check-version
 check-version:
 ifndef VERSION
 	$(error VERSION not defined)
-endif 
+endif

README.md

@@ -9,9 +9,10 @@ A simple Github Action that allows us to update the status of a commit.
 
 GitHub does not update the status of a commit when running workflow and therefore tools that rely on the context/status of a given commit are not compatible with it.
 
-Currently the action supports `pull_request`, `pull_request_target` and `push` events:
+Currently the action supports `pull_request`, `pull_request_target`, `merge_group`, and `push` events:
+
 * When the event is `pull_request` or `pull_request_target`, the action will set the status to the last commit in the pull request at the moment the workflow was triggered.
-* When the event is `push`, the action will set the status to the last commit pushed at the moment the workflow was triggered.
+* When the event is `push` or `merge_group`, the action will set the status to the last commit pushed at the moment the workflow was triggered.
 
 ## Input Parameters
 
@@ -35,7 +36,7 @@ If set to `error` it will set status commit `error`.
 
 ## Input Parameters specific to `pull_request` event
 
-_These parameters are all optional and are used only for pull requests_
+_These parameters are all optional and are used only for pull requests._
 
 | Name | Description |
 |---|---|
@@ -52,11 +53,11 @@ By default, if we don't add `permissions` to the workflow or the job, the action
 * If we just want to set the status commit we need to be sure the job (or the whole workflow) has the permission: `statuses: write`
 * If we want to add a comment we need to be sure the job (or the whole workflow) has the permissions: `pull-requests: write`
 
-## Examples 
+## Examples
 
 ### Action sets push commit to pending status
 
-```
+```yaml
 name: Test
 
 on: [push]
@@ -71,12 +72,12 @@ jobs:
 
 ### Action sets push commit to pending status with specific permissions
 
-```
+```yaml
 name: Test
 
 on: [push]
 
-permissions: 
+permissions:
   statuses: write
 
 jobs:
@@ -87,10 +88,9 @@ jobs:
     - uses: ouzi-dev/commit-status-updater@v2
 ```
 
-
 ### Action sets push commit to pending status with custom name
 
-```
+```yaml
 name: Test
 
 on: [push]
@@ -107,7 +107,7 @@ jobs:
 
 ### Action sets push commit to pending status on start, and updates check at the end of the workflow
 
-```
+```yaml
 name: Test
 
 on: [push]
@@ -126,7 +126,7 @@ jobs:
 
 ### Action sets pull request commit to pending status without comment
 
-```
+```yaml
 name: Test
 
 on: [pull_request]
@@ -141,7 +141,7 @@ jobs:
 
 ### Action sets pull request commit to error status without comment
 
-```
+```yaml
 name: Test
 
 on: [pull_request]
@@ -158,7 +158,7 @@ jobs:
 
 ### Action sets pull request commit to pending status with comment, and updates check and adds comment at the end of the workflow
 
-```
+```yaml
 name: Test
 
 on: [pull_request]
@@ -180,12 +180,12 @@ jobs:
 
 ### Action sets pull request commit to pending status with comment, and updates check and adds comment at the end of the workflow with specific permissions
 
-```
+```yaml
 name: Test
 
 on: [pull_request]
 
-permissions: 
+permissions:
   statuses: write
   pull-requests: write
 
@@ -206,7 +206,7 @@ jobs:
 
 ### Action with custom hold comments
 
-```
+```yaml
 name: Test
 
 on: [pull_request]
@@ -224,10 +224,10 @@ jobs:
         successComment: "action success!"
         failComment: "action failed!"
 ```
- 
+
 ### Action no comments, set commit to "error" status and set url, description and specific name
 
-```
+```yaml
 name: Test
 
 on: [pull_request]
@@ -247,7 +247,7 @@ jobs:
 
 ### Action with specific token and setting status check in commits in forks
 
-```
+```yaml
 name: Test
 
 on: [pull_request]
@@ -265,12 +265,12 @@ jobs:
 
 ## Integration with Prow
 
-An example is [Prow](https://github.com/kubernetes/test-infra/tree/master/prow#readme) which uses the Github Status API to read the status of a given commit. 
+An example is [Prow](https://github.com/kubernetes/test-infra/tree/master/prow#readme) which uses the Github Status API to read the status of a given commit.
 Using this actions you can tell tide to not skip optional contexts and effectively wait for a GitHub Workflow to pass before merging.
 
 ### Example with Tide
 
-```
+```yaml
 tide:
   context_options:
     # Treat unknown contexts as required

dist/index.js

@@ -1,3 +1,6 @@
+// Code generated via make release - DO NOT EDIT
+
+
 /******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 
@@ -71,7 +74,7 @@ class GithubHelper {
                 this.baseOwner = (_2 = (_1 = (_0 = (_z = (_y = github_1.context.payload) === null || _y === void 0 ? void 0 : _y.pull_request) === null || _z === void 0 ? void 0 : _z.base) === null || _0 === void 0 ? void 0 : _0.repo) === null || _1 === void 0 ? void 0 : _1.owner) === null || _2 === void 0 ? void 0 : _2.login;
                 this.baseRepoName = (_6 = (_5 = (_4 = (_3 = github_1.context.payload) === null || _3 === void 0 ? void 0 : _3.pull_request) === null || _4 === void 0 ? void 0 : _4.base) === null || _5 === void 0 ? void 0 : _5.repo) === null || _6 === void 0 ? void 0 : _6.name;
             }
-            if (github_1.context.eventName === 'push') {
+          if (['push', 'merge_group'].includes(github_1.context.eventName)) {
                 this.isPR = false;
                 this.owner = (_9 = (_8 = (_7 = github_1.context.payload) === null || _7 === void 0 ? void 0 : _7.repository) === null || _8 === void 0 ? void 0 : _8.owner) === null || _9 === void 0 ? void 0 : _9.login;
                 this.repo = (_11 = (_10 = github_1.context.payload) === null || _10 === void 0 ? void 0 : _10.repository) === null || _11 === void 0 ? void 0 : _11.name;
@@ -105,7 +108,18 @@ class GithubHelper {
                 core.info(`Updated build status: ${params.status}`);
             }
             catch (error) {
-                throw new Error(`error while setting context status: ${error.message}`);
+                /*
+                    There is a point where a merge group has been merged and checks
+                    may be re-run, where this status update does not appear possible
+                    from some context/state reason that is not clear.
+                    Therefore we try to sidestep this a bit and either allow this to
+                    pass or fail without actually updating anything.
+                */
+                const SUCCESS = 'success';
+                core.warning(`Unable to properly update build status: ${params.status}`);
+                if (params.status !== SUCCESS) {
+                    throw new Error(`Check ended with status: ${params.status}`);
+                }
             }
         });
     }
@@ -456,8 +470,9 @@ function validateEventType() {
     return __awaiter(this, void 0, void 0, function* () {
         if (github.context.eventName !== 'pull_request' &&
             github.context.eventName !== 'pull_request_target' &&
+            github.context.eventName !== 'merge_group' &&
             github.context.eventName !== 'push') {
-            throw new Error('Error, action only works for pull_request, pull_request_target or push events!');
+            throw new Error('Error, action only works for pull_request, pull_request_target, merge_group or push events!');
         }
     });
 }

package-lock.json

@@ -9,7 +9,7 @@
     "format": "prettier --write **/*.ts",
     "format-check": "prettier --check **/*.ts",
     "lint": "eslint src/**/*.ts",
-    "pack": "ncc build",
+    "pack": "ncc build && mv dist/index.js dist/index.js.tmp && echo '// Code generated via make release - DO NOT EDIT\n\n' > dist/index.js && cat dist/index.js.tmp >> dist/index.js && rm -f dist/index.js.tmp",
     "test": "jest",
     "coverage": "jest --coverage=true",
     "clean": "rm -rf node_modules && rm -rf lib && rm -rf coverage && rm -rf dist",
@@ -51,7 +51,7 @@
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/github": "^8.0.6",
     "@semantic-release/release-notes-generator": "^10.0.3",
-    "@types/jest": "^29.2.0",
+    "@types/jest": "^29.5.14",
     "@types/node": "^18.11.2",
     "@types/uuid": "^8.3.4",
     "@typescript-eslint/eslint-plugin": "^5.40.1",

package.json

@@ -34,7 +34,11 @@ class GithubHelper {
   }
 
   private async initialize(): Promise<void> {
-    if (['pull_request', 'pull_request_target'].includes(context.eventName)) {
+    if (
+      ['pull_request', 'pull_request_target'].includes(
+        context.eventName
+      )
+    ) {
       this.isPR = true
       this.owner = context.payload?.pull_request?.head?.repo?.owner?.login
       this.repo = context.payload?.pull_request?.head?.repo?.name
@@ -46,7 +50,11 @@ class GithubHelper {
       this.baseRepoName = context.payload?.pull_request?.base?.repo?.name
     }
 
-    if (context.eventName === 'push') {
+    if (
+      ['push', 'merge_group'].includes(
+        context.eventName
+      )
+    ) {
       this.isPR = false
       this.owner = context.payload?.repository?.owner?.login
       this.repo = context.payload?.repository?.name
@@ -74,8 +82,9 @@ class GithubHelper {
         state: params.status,
         target_url: params.url
       })
-      core.info(`Updated build status: ${params.status}`)
+      core.info(`Updated build status for ${params.name}: ${params.status}`)
     } catch (error) {
+      core.warning(`Unable to properly update build status for ${params.name}: ${params.status}`)
       throw new Error(
         `error while setting context status: ${(error as Error).message}`
       )

src/githubHelper.ts

@@ -4,10 +4,11 @@ export async function validateEventType(): Promise<void> {
   if (
     github.context.eventName !== 'pull_request' &&
     github.context.eventName !== 'pull_request_target' &&
+    github.context.eventName !== 'merge_group' &&
     github.context.eventName !== 'push'
   ) {
     throw new Error(
-      'Error, action only works for pull_request, pull_request_target or push events!'
+      'Error, action only works for pull_request, pull_request_target, merge_group or push events!'
     )
   }
 }