Skip to content

Commit 9047c2c

Browse files
authored
[CRCR] Update conclusion input description to clarify requirements and accepted values (#8173)
This PR makes `conclusion` a passthrough value from GitHub to AWS Lambda so that we can have more status showing on the `L2+` HUD and `L3+` check run (especially for the `cancelled` status). cc @KarhouTam @fffrog @atalman @subinz1 @@jewelkm89
1 parent fa8b976 commit 9047c2c

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

.github/actions/cross-repo-ci-relay-callback/action.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ inputs:
1818
required: true
1919
conclusion:
2020
description: >
21-
Conclusion of the workflow run. Required (and must be "success" or
22-
"failure") when status is "completed". Ignored when status is
23-
"in_progress".
21+
Conclusion of the workflow run, passed through to the check run as-is
22+
(typically "${{ job.status }}"). Required when status is "completed" and
23+
must be a value GitHub accepts (e.g. success, failure, cancelled). Ignored
24+
when status is "in_progress".
2425
required: false
2526
default: ''
2627
test-results:
@@ -88,9 +89,9 @@ runs:
8889
if status not in ("in_progress", "completed"):
8990
sys.exit(f"::error::status must be 'in_progress' or 'completed', got {status!r}")
9091
92+
# Pass the conclusion through as-is for completed runs; GitHub validates
93+
# it when the check run is created. in_progress runs carry no conclusion.
9194
conclusion = os.environ.get("CONCLUSION", "").strip() or None
92-
if status == "completed" and conclusion not in ("success", "failure"):
93-
sys.exit("::error::conclusion must be 'success' or 'failure' when status is 'completed'")
9495
if status == "in_progress":
9596
conclusion = None
9697

aws/lambda/cross_repo_ci_relay/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ jobs:
170170
| Input | Required | Default | Description |
171171
|---|---|---|---|
172172
| `status` | **yes** | — | `in_progress` or `completed` |
173-
| `conclusion` | no | `''` | `success` or `failure` (required when `status=completed`) |
173+
| `conclusion` | no | `''` | Passed through to the check run as-is (typically `${{ job.status }}`); required when `status=completed` and must be a value GitHub accepts (e.g. `success`, `failure`, `cancelled`) |
174174
| `test-results` | no | `''` | Optional JSON string with test result summary (counts: passed/failed/skipped) |
175175
| `callback-url` | **yes** | — | Callback endpoint URL (production Lambda URL; set once at the workflow level) |
176176
| `artifact-url` | no | `''` | URL to downstream-hosted artifacts (logs, reports, results) |

0 commit comments

Comments
 (0)