Skip to content

fix: sync-status reports success for runs that did not succeed #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alecsammon wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −3
Open

fix: sync-status reports success for runs that did not succeed #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40787,6 +40787,7 @@ var version = "1.3.2";

// src/main.ts
var API_VERSION = "2026-03-10";
var FAILED_CONCLUSIONS = /* @__PURE__ */ new Set(["failure", "cancelled", "timed_out", "startup_failure", "stale"]);
async function run() {
info(`\u{1F3C3} Workflow Dispatch Action v${version}`);
try {
Expand Down Expand Up @@ -40878,11 +40879,20 @@ Note: The workflow is still running but we have stopped waiting. You can check t
headers: { "x-github-api-version": API_VERSION }
}
);
const runStatusNow = finalRunData.status;
const conclusion = finalRunData.conclusion;
if (conclusion === "failure") {
if (runStatusNow !== "completed") {
setFailed(
`Workflow run did not complete (status: ${runStatusNow}). Check the run details here: ${dispatchResp.data.html_url}`
);
} else if (conclusion === "failure") {
setFailed(`Workflow run failed. Check the run details here: ${dispatchResp.data.html_url}`);
} else if (conclusion === "cancelled") {
setFailed(`Workflow run was cancelled. Check the run details here: ${dispatchResp.data.html_url}`);
} else if (FAILED_CONCLUSIONS.has(String(conclusion))) {
setFailed(
`Workflow run concluded '${conclusion}'. Check the run details here: ${dispatchResp.data.html_url}`
);
} else {
info(`\u{1F389} Workflow conclusion: ${conclusion}`);
}
Expand Down
18 changes: 16 additions & 2 deletions src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ import * as PackageJSON from '../package.json'

const API_VERSION = '2026-03-10' // Latest API version as of March 2026, update as needed

// Conclusions that unambiguously mean the run did not succeed. `neutral`,
// `skipped` and `action_required` are left passing, as before.
const FAILED_CONCLUSIONS = new Set(['failure', 'cancelled', 'timed_out', 'startup_failure', 'stale'])

type Workflow = {
id: number
name: string
Expand Down Expand Up @@ -154,13 +158,23 @@ async function run(): Promise<void> {
headers: { 'x-github-api-version': API_VERSION },
},
)
const runStatusNow = finalRunData.status
const conclusion = finalRunData.conclusion

// Set this action to failed if the triggered workflow run failed or was cancelled
if (conclusion === 'failure') {
// An incomplete run has no conclusion yet, so passing here would report
// success for work still in flight (e.g. after the wait above timed out).
if (runStatusNow !== 'completed') {
core.setFailed(
`Workflow run did not complete (status: ${runStatusNow}). Check the run details here: ${dispatchResp.data.html_url}`,
)
} else if (conclusion === 'failure') {
core.setFailed(`Workflow run failed. Check the run details here: ${dispatchResp.data.html_url}`)
} else if (conclusion === 'cancelled') {
core.setFailed(`Workflow run was cancelled. Check the run details here: ${dispatchResp.data.html_url}`)
} else if (FAILED_CONCLUSIONS.has(String(conclusion))) {
core.setFailed(
`Workflow run concluded '${conclusion}'. Check the run details here: ${dispatchResp.data.html_url}`,
)
} else {
core.info(`🎉 Workflow conclusion: ${conclusion}`)
}
Expand Down
Loading