Document workflow run statuses and conclusions#45193
Conversation
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
|
Thanks for taking this on. I compared the draft with the specific questions in #34987 and the current Actions and Checks references. The article shape and three-file scope look right. Three bounded additions/corrections would close the remaining gaps:
These points preserve the concise reference format while answering the issue's transition and property-delineation requests. |
GitHub Copilot generated this pull request.
Note
This pull request should have the
llm-generatedlabel. External contributors do not have permission to add labels to this repository.Why:
Closes: #34987
The issue is labeled
help wantedandSME reviewed; the Actions SME requested a new reference article defining workflow run statuses and conclusions, linked from the REST API documentation.What's being changed:
statusvalues from the nineconclusionvalues exposed by the currentworkflow_runwebhook schema.startup_failureis a webhook conclusion but is not accepted by the workflow run list endpoints'statusfilter.This builds on the useful direction in #44984 by @happysnaker. It preserves the existing frontmatter formatting requested in that pull request's review and removes speculative "typical use case" claims that are not established by the public schema.
Technical values were checked against the current workflow run REST endpoint documentation and the
workflow_runwebhook schema in this repository.Verification:
npm run lint-content -- --paths content/actions/reference/workflows-and-actions/index.md content/actions/reference/workflows-and-actions/workflow-run-statuses.md content/rest/actions/workflow-runs.md— no errors.npm run build— passed.CHANGED_FILES="content/actions/reference/workflows-and-actions/index.md content/actions/reference/workflows-and-actions/workflow-run-statuses.md content/rest/actions/workflow-runs.md" npm run test -- src/content-render/tests/render-changed-and-deleted-files.ts— 1 test file and 2 tests passed.Check off the following: