feat: add `require-checks-in-pr` composite action by devantler · Pull Request #113 · devantler-tech/actions

devantler · 2026-04-20T16:45:54Z

Description

Adds a shared composite action that aggregates the results of multiple CI jobs into a single required check. Extracted from ksail's local .github/actions/summarize-workflow.

Inputs

Input	Description	Required	Default
`job-results`	Space-separated list of job results to check	Yes	—
`check-name`	Display name used in success/failure messages	No	`CI - Required Checks`

Behavior

success and skipped → pass
failure and cancelled → fail

Motivation

Branch protection rules need a single, stable check name. This action provides that by aggregating results from matrix builds or parallel jobs.

See require-checks-in-pr/README.md for usage examples.

Extracted from ksail's local .github/actions/summarize-workflow into a shared composite action. Aggregates multiple job results into a single required check for branch protection rules. Inputs: - job-results (required): space-separated list of job results - check-name (default: "CI - Required Checks"): name for messages Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds a reusable composite GitHub Action to aggregate multiple job results into one required check outcome, supporting branch protection rules that need a stable check name.

Changes:

Introduces require-checks-in-pr composite action that fails if any dependent job failed/cancelled and passes on success/skipped.
Adds documentation with usage examples, inputs, and result semantics.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File	Description
require-checks-in-pr/action.yaml	Implements the composite action logic to aggregate job results into a single pass/fail outcome.
require-checks-in-pr/README.md	Documents motivation, usage patterns, inputs, and interpretation of job result values.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-20T16:48:27Z

+        set -Eeuo pipefail
+        failed=false
+
+        for result in $JOB_RESULTS; do
+          case "$result" in
+            success|skipped)
+              ;;
+            *)
+              failed=true
+              ;;
+          esac
+        done


If job-results is provided as an empty/whitespace-only string, the loop never runs and the action will incorrectly succeed. Add an explicit validation that JOB_RESULTS contains at least one non-whitespace token and fail with a clear message if it doesn't.

Copilot · 2026-04-20T16:48:27Z

+
+        for result in $JOB_RESULTS; do
+          case "$result" in
+            success|skipped)
+              ;;
+            *)
+              failed=true
+              ;;
+          esac
+        done
+


The default (*) branch treats any unexpected value as a failure/cancel and prints a message that may be inaccurate (e.g., typo/unknown result). Consider handling failure|cancelled explicitly, and for unknown values print an error like Unknown job result: <value> (optionally listing allowed values) and exit non-zero to make misconfigurations easier to diagnose.

Suggested change

for result in $JOB_RESULTS; do

case "$result" in

success|skipped)

;;

*)

failed=true

;;

esac

done

unknown_result=""

for result in $JOB_RESULTS; do

case "$result" in

success|skipped)

;;

failure|cancelled)

failed=true

;;

*)

unknown_result="$result"

break

;;

esac

done

if [ -n "$unknown_result" ]; then

echo "❌ $CHECK_NAME — Unknown job result: $unknown_result. Allowed values: success, failure, cancelled, skipped."

exit 1

fi

Copilot · 2026-04-20T16:48:28Z

+        done
+
+        if [ "$failed" = true ]; then
+          echo "❌ $CHECK_NAME — at least one job failed or was cancelled."


The default (*) branch treats any unexpected value as a failure/cancel and prints a message that may be inaccurate (e.g., typo/unknown result). Consider handling failure|cancelled explicitly, and for unknown values print an error like Unknown job result: <value> (optionally listing allowed values) and exit non-zero to make misconfigurations easier to diagnose.

Copilot · 2026-04-20T16:48:28Z

+      - uses: devantler-tech/actions/require-checks-in-pr@main
+        with:
+          job-results: "${{ needs.build.result }} ${{ needs.test.result }}"


The examples pin the action to @main, which is vulnerable to supply-chain risk and can introduce unexpected breaking changes. Prefer pinning to an immutable ref (a commit SHA) or a release tag (e.g., @v1) and update the README examples accordingly.

Copilot · 2026-04-20T16:48:28Z

+    needs: [build, lint, test]
+    if: ${{ always() }}
+    steps:
+      - uses: devantler-tech/actions/require-checks-in-pr@main


The examples pin the action to @main, which is vulnerable to supply-chain risk and can introduce unexpected breaking changes. Prefer pinning to an immutable ref (a commit SHA) or a release tag (e.g., @v1) and update the README examples accordingly.

botantler · 2026-04-20T16:48:48Z

🎉 This PR is included in version 3.2.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

- Fail with a clear message when job-results is empty or whitespace-only - Handle failure|cancelled explicitly instead of relying on catch-all - Report unknown job result values with actionable error message Addresses review feedback from #113. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

@main

* fix: validate empty input and handle unknown job results - Fail with a clear message when job-results is empty or whitespace-only - Handle failure|cancelled explicitly instead of relying on catch-all - Report unknown job result values with actionable error message Addresses review feedback from #113. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: pin README examples to SHA instead of @main Pin action references to the v3.2.0 release SHA for supply-chain safety. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: address reviewer feedback on echo and allowed_values duplication Agent-Logs-Url: https://github.com/devantler-tech/actions/sessions/a2b7624d-f1ad-4173-b521-d8c2de93ad5c Co-authored-by: devantler <26203420+devantler@users.noreply.github.com> * fix: use printf, disable globbing, and parse into array for robustness - Replace echo with printf '%s\n' to avoid option misinterpretation - Use read -r -a to parse JOB_RESULTS into an array safely - Disable globbing with set -f to prevent wildcard expansion Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: devantler <26203420+devantler@users.noreply.github.com>

devantler and others added 2 commits April 20, 2026 18:45

docs: add README for require-checks-in-pr action

61ae89e

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings April 20, 2026 16:45

botantler Bot approved these changes Apr 20, 2026

View reviewed changes

botantler Bot enabled auto-merge (squash) April 20, 2026 16:46

Copilot started reviewing on behalf of devantler April 20, 2026 16:46 View session

devantler disabled auto-merge April 20, 2026 16:48

devantler merged commit 1f66c91 into main Apr 20, 2026
48 checks passed

devantler deleted the feat/require-checks-in-pr branch April 20, 2026 16:48

devantler mentioned this pull request Apr 20, 2026

refactor: replace local summarize-workflow with shared require-checks-in-pr action devantler-tech/ksail#4209

Merged

Copilot AI reviewed Apr 20, 2026

View reviewed changes

botantler Bot added the released label Apr 20, 2026

devantler mentioned this pull request Apr 20, 2026

feat: add CI - Required Checks aggregation job devantler-tech/copilot-plugins#5

Merged

devantler mentioned this pull request Apr 20, 2026

fix: address review feedback on require-checks-in-pr action #116

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `require-checks-in-pr` composite action#113

feat: add `require-checks-in-pr` composite action#113
devantler merged 2 commits intomainfrom
feat/require-checks-in-pr

devantler commented Apr 20, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

botantler Bot commented Apr 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

devantler commented Apr 20, 2026

Description

Inputs

Behavior

Motivation

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

botantler Bot commented Apr 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants