From 502fff8fb6e1c273ff99e8e84feece733aa075c4 Mon Sep 17 00:00:00 2001 From: Wechuli Date: Wed, 22 Oct 2025 16:49:32 +0300 Subject: [PATCH] Update README for clarity on check runs and statuses Clarified wording regarding check run extraction and commit statuses in the README. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 67388f5..339a938 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This action will check that all checks have passed on a given pull request. ### What's Changed - Upgrade to Node24 runtime -- On GitHub.com, the name of the check run created by the workflow itself is extracted from the available `job.check_run_id` context using this action as a reusable is now supported. This functionality is not yet available on GitHub Enterprise Server (GHES), will likely be available on the next release version - 3.18. On GitHub Enterprise Server, the action will attempt to extract its check name from the workflow file. +- On GitHub.com, the name of the check run created by the workflow itself is extracted from the available `job.check_run_id` context, using this action as a reusable is now supported. This functionality is not yet available on GitHub Enterprise Server (GHES), will likely be available on the next release version - 3.18. On GitHub Enterprise Server, the action will attempt to extract its check name from the workflow file. - Support for [commit statuses](https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28#about-commit-statuses) is now implemented on V2. To prevent a breaking change, this is disabled by default. You can enable it by setting the `include_commit_statuses` input to `true`. ## Basic usage @@ -208,7 +208,7 @@ By default, the action will create a job summary with the details of each check ### Status Commits -You can choose to include commit statuses in addition to checks for evaluation. By default, this is disabled. If your CI/CD is only every running on GitHub Actions and you are not explicitly calling the commit status API, then that option can default to false as is. If you have an external integration (such as Jenkins) that is reporting commit statuses instead of checks, you can set the `include_commit_statuses` option to `true` so that those are evaluated as well. +You can choose to include commit statuses in addition to checks for evaluation. By default, this is disabled. If your CI/CD is only ever running on GitHub Actions and you are not explicitly calling the commit status API, then that option can be left to default to false as is. If you have an external integration (such as Jenkins) that is reporting commit statuses instead of checks, you can set the `include_commit_statuses` option to `true` so that those are evaluated as well. ```yaml steps: