Implement list-based waiting using GraphQL APIs (#574)

kachick · Oct 2, 2023 · c782d13 · c782d13
1 parent 6e2d7c3
commit c782d13
Show file tree

Hide file tree

Showing 9 changed files with 5,954 additions and 670 deletions.
diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
@@ -22,3 +22,5 @@ jobs:
           # https://spdx.org/licenses/
           allow-licenses: MIT, BSD-3-Clause, BSD-2-Clause, 0BSD, Unlicense, ISC, Apache-2.0, CC-BY-4.0
           allow-dependencies-licenses: pkg:githubactions/DeterminateSystems/nix-installer-action@4
+          # https://github.com/colinhacks/zod/pull/2824 - Email regex is not related to this repo
+          allow-ghsas: GHSA-m95q-7qp3-xv42
diff --git a/.github/workflows/itself.yml b/.github/workflows/itself.yml
@@ -43,3 +43,45 @@ jobs:
           retry-method: 'equal_intervals'
           min-interval-seconds: 10
           attempt-limits: 60
+  wait-list:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor != 'dependabot[bot]' && github.actor != 'renovate[bot]' }}
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./
+        with:
+          retry-method: 'equal_intervals'
+          min-interval-seconds: 5
+          attempt-limits: 30
+          wait-list: |
+            [
+              {
+                "workflowFile": "lint.yml"
+              },
+              {
+                "workflowFile": "merge-bot-pr.yml",
+                "jobName": "dependabot"
+              }
+            ]
+  skip-list:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor != 'dependabot[bot]' && github.actor != 'renovate[bot]' }}
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./
+        with:
+          retry-method: 'equal_intervals'
+          min-interval-seconds: 5
+          attempt-limits: 30
+          skip-list: |
+            [
+              {
+                "workflowFile": "ci.yml"
+              },
+              {
+                "workflowFile": "merge-bot-pr.yml",
+                "jobName": "dependabot"
+              }
+            ]
diff --git a/README.md b/README.md
@@ -3,6 +3,8 @@
 [![CI](https://github.com/kachick/wait-other-jobs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/kachick/wait-other-jobs/actions/workflows/ci.yml?query=event%3Apush++)
 [![Itself](https://github.com/kachick/wait-other-jobs/actions/workflows/itself.yml/badge.svg?branch=main)](https://github.com/kachick/wait-other-jobs/actions/workflows/itself.yml?query=event%3Apush++)
 
+This README describes development version as main branch, refer [v1 README](https://github.com/kachick/wait-other-jobs/blob/v1/README.md) for released versions.
+
 ## Overview
 
 This action waits all GitHub Action jobs even if they are running in other workflows.\
@@ -33,19 +35,37 @@ jobs:
   with-waiting:
     runs-on: ubuntu-latest
     steps:
-      - name: Wait for other jobs to pass or fail
-        uses: kachick/wait-other-jobs@v1.3.0
+      - uses: kachick/wait-other-jobs@v2.0.0
         timeout-minutes: 15
 ```
 
-You can change the token, status polling interval and turns early-exit as below.
+You can change the token, polling interval, allow/deny list and turns early-exit as below.
 
 ```yaml
 with:
   github-token: "${{ secrets.YOUR_PAT }}"
   min-interval-seconds: '300' # default '30'
   retry-method: 'equal_intervals' # default 'exponential_backoff'
   early-exit: 'false' # default 'true'
+  # lists should be given with JSON formatted array, do not specify both wait-list and skip-list
+  # Each items should have "workflowFile" field and they can optinaly have "jobName" field
+  # If no jobName is specified, all of jobs in the workflow will be targeted
+  wait-list: |
+    [
+      {
+        "workflowFile": "ci.yml",
+        "jobName": "test"
+      },
+      {
+        "workflowFile": "release.yml"
+      }
+    ]
+  skip-list: |
+    [
+      {
+        "workflowFile": "pages.yml",
+      }
+    ]
 ```
 
 Full list of the changeable parameters
@@ -57,7 +77,9 @@ Full list of the changeable parameters
 | `retry-method`         | How to wait for next polling                                                    | `string` | `false`  | `exponential_backoff` | `exponential_backoff`, `equal_intervals` |
 | `early-exit`           | Stop rest pollings if faced at least 1 bad condition                            | `bool`   | `false`  | `true`                |                                          |
 | `attempt-limits`       | Stop rest pollings after this attempts even if other jobs are not yet completed | `number` | `false`  | `1000`                |                                          |
-| `dry-run`              | Avoid http requests for tests                                                   | `bool`   | `false`  | `false`               |                                          |
+| `wait-list`            | This action will not wait for items other than this list                        | `string` | `false`  | `[]`                  |                                          |
+| `skip-list`            | This action will not wait for items on this list                                | `string` | `false`  | `[]`                  |                                          |
+| `dry-run`              | Avoid requests for tests                                                        | `bool`   | `false`  | `false`               |                                          |
 
 Below is a typical usecase. Assume test jobs defined in another workflow.
 
@@ -78,11 +100,11 @@ jobs:
     steps:
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v1.5.1
-      - uses: actions/checkout@v3
+        uses: dependabot/fetch-metadata@v1.6.0
+      - uses: actions/checkout@v4
       - name: Wait for other jobs to pass or fail
         if: ${{steps.metadata.outputs.update-type != 'version-update:semver-major'}}
-        uses: kachick/wait-other-jobs@v1.3.0
+        uses: kachick/wait-other-jobs@v2.0.0
         timeout-minutes: 10
       - name: Approve and merge
         if: ${{steps.metadata.outputs.update-type != 'version-update:semver-major'}}
@@ -95,9 +117,9 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ github.actor == 'renovate[bot]' }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Wait for other jobs to pass or fail
-        uses: kachick/wait-other-jobs@v1.3.0
+        uses: kachick/wait-other-jobs@v2.0.0
         timeout-minutes: 10
       - name: Approve and merge
         run: gh pr review --approve "$PR_URL" && gh pr merge --auto --squash "$PR_URL"
@@ -111,6 +133,9 @@ jobs:
 Judge OK or Bad with the checkRun state at the moment.\
 When some jobs will be triggered after this action with `needs: [distant-first]`, it might be unaccurate. (I didn't faced yet)
 
+If any workflow starts many jobs as 100+, this action does not support it.\
+Because of nested paging in GraphQL makes complex. See [related docs](https://github.com/octokit/plugin-paginate-graphql.js/blob/a6b12e867466b0c583b002acd1cb1ed90b11841f/README.md#L184-L218) for further detail.
+
 ## GITHUB_TOKEN vs PAT
 
 This action just requires following GITHUB_TOKEN permissions. Needless annoying setup and needless unsecure around PAT.

diff --git a/action.yml b/action.yml
@@ -25,6 +25,14 @@ inputs:
     description: 'Stop rest pollings after this limits even if other jobs are not yet completed'
     required: false
     default: '1000' # Enough large
+  wait-list:
+    description: 'This action will not wait for items other than this list'
+    required: false
+    default: '[]'
+  skip-list:
+    description: 'This action will not wait for items on this list'
+    required: false
+    default: '[]'
   dry-run:
     description: 'Avoid http requests for tests'
     required: false