fix: update the pull_request property description on check_run event

octokit · Apr 28, 2022 · 3218b97 · 3218b97
1 parent c36d1c4
commit 3218b97
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/payload-schemas/api.github.com/check_run/completed.schema.json b/payload-schemas/api.github.com/check_run/completed.schema.json
@@ -132,7 +132,7 @@
             "before": { "type": ["string", "null"] },
             "after": { "type": ["string", "null"] },
             "pull_requests": {
-              "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
+              "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.  \n  \n**Note:**\n\n*   The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n*   When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
               "type": "array",
               "items": { "$ref": "common/check-run-pull-request.schema.json" }
             },

diff --git a/payload-schemas/api.github.com/check_run/created.schema.json b/payload-schemas/api.github.com/check_run/created.schema.json
@@ -133,7 +133,7 @@
             "after": { "type": ["string", "null"] },
             "pull_requests": {
               "type": "array",
-              "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
+              "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.  \n  \n**Note:**\n\n*   The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n*   When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
               "items": { "$ref": "common/check-run-pull-request.schema.json" }
             },
             "deployment": { "$ref": "common/check-run-deployment.schema.json" },

diff --git a/payload-schemas/api.github.com/check_run/requested_action.schema.json b/payload-schemas/api.github.com/check_run/requested_action.schema.json
@@ -139,7 +139,7 @@
             "after": { "type": ["string", "null"] },
             "pull_requests": {
               "type": "array",
-              "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
+              "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.  \n  \n**Note:**\n\n*   The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n*   When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
               "items": { "$ref": "common/check-run-pull-request.schema.json" }
             },
             "deployment": { "$ref": "common/check-run-deployment.schema.json" },

diff --git a/payload-schemas/api.github.com/check_run/rerequested.schema.json b/payload-schemas/api.github.com/check_run/rerequested.schema.json
@@ -125,7 +125,7 @@
             "before": { "type": ["string", "null"] },
             "after": { "type": ["string", "null"] },
             "pull_requests": {
-              "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
+              "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.  \n  \n**Note:**\n\n*   The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n*   When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
               "type": "array",
               "items": { "$ref": "common/check-run-pull-request.schema.json" }
             },