WorkflowJob.conclusion missing strings in enum

[Caeleron]

webhooks/payload-schemas/api.github.com/common/workflow-job.schema.json

Line 51 in 97ffd1b

"enum": ["success", "failure", null]

Relevant schema:

"check_run[conclusion]": {
        "type": "string",
        "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`."
      },

It is possible to have a conclusion of cancelled in the completed field for this event; however, the current types only allow for "success" or "failure".

[wolfy1339]

Thanks for letting us know.

Next time, it would be appreciated if you could share an example of the payload you received.

This will be fixed in the next batch of updates

[Caeleron]

Here's the relevant part of the payloads I noticed for posterity. Sorry about that. For context, the first one was a job that was cancelled after being queued but before starting. The second was a job that depends on the first that was never queued at all.

{
  "action": "completed",
  "workflow_job": {
    "id": 6799789894,
    "run_id": 2463583454,
    "run_url": "https://api.github.com/repos/ORG/REPO/actions/runs/2463583454",
    "run_attempt": 2,
    "node_id": "CR_kwDOHNYgOM8AAAABlUyPRg",
    "head_sha": "80686dbf704f98b63e40cfcea041a6ea88d6d72b",
    "url": "https://api.github.com/repos/ORG/REPO/actions/jobs/6799789894",
    "html_url": "https://github.com/ORG/REPO/runs/6799789894?check_suite_focus=true",
    "status": "completed",
    "conclusion": "cancelled",
    "started_at": "2022-06-08T18:52:47Z",
    "completed_at": "2022-06-08T18:52:47Z",
    "name": "Job 1",
    "steps": [

    ],
    "check_run_url": "https://api.github.com/repos/ORG/REPO/check-runs/6799789894",
    "labels": [
      "self-hosted",
      "ephemeral"
    ],
    "runner_id": null,
    "runner_name": null,
    "runner_group_id": null,
    "runner_group_name": null
  },
  ...
}

{
  "action": "completed",
  "workflow_job": {
    "id": 6800028955,
    "run_id": 2463583454,
    "run_url": "https://api.github.com/repos/ORG/REPO/actions/runs/2463583454",
    "run_attempt": 2,
    "node_id": "CR_kwDOHNYgOM8AAAABlVA1Gw",
    "head_sha": "80686dbf704f98b63e40cfcea041a6ea88d6d72b",
    "url": "https://api.github.com/repos/ORG/REPO/actions/jobs/6800028955",
    "html_url": "https://github.com/ORG/REPO/runs/6800028955?check_suite_focus=true",
    "status": "completed",
    "conclusion": "skipped",
    "started_at": "2022-06-08T18:52:48Z",
    "completed_at": "2022-06-08T18:52:48Z",
    "name": "Job 2",
    "steps": [

    ],
    "check_run_url": "https://api.github.com/repos/ORG/REPO/check-runs/6800028955",
    "labels": [

    ],
    "runner_id": null,
    "runner_name": null,
    "runner_group_id": null,
    "runner_group_name": null
  },
  ...
}

[octokitbot]

🎉 This issue has been resolved in version 5.8.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)
• npm package (@latest dist-tag)
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀