Skip to content
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.

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

[BUG]: There's no WorkflowJobStatus.Waiting #2730

Closed
1 task done
vuryleo opened this issue Jun 28, 2023 · 4 comments · Fixed by #2732
Closed
1 task done

[BUG]: There's no WorkflowJobStatus.Waiting #2730

vuryleo opened this issue Jun 28, 2023 · 4 comments · Fixed by #2732
Labels
Status: Triage This is being looked at and prioritized Type: Bug Something isn't working as documented

Comments

@vuryleo
Copy link
Contributor

vuryleo commented Jun 28, 2023

What happened?

While querying for the workflow job status, suddenly it returns sth other than queued in_progress nor completed but waiting.
As it's waiting for some prod approval.

Versions

octoket v6.1.0

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@vuryleo vuryleo added Status: Triage This is being looked at and prioritized Type: Bug Something isn't working as documented labels Jun 28, 2023
@kfcampbell
Copy link
Member

Interesting...it seems like that was missed in the specification. The docs here show the following options:

    "status": {
      "description": "The phase of the lifecycle that the job is currently in.",
      "type": "string",
      "enum": [
        "queued",
        "in_progress",
        "completed"
      ],
      "examples": [
        "queued"
      ]
    },

but I do see where the API returns waiting.

@kfcampbell
Copy link
Member

I've asked around internally about why this may be the case, and I'll follow up here before taking action on your PR. Thanks!

@kfcampbell
Copy link
Member

It seems like there's several API schemas that do and do not have "waiting" as a status. The docs linked above also have a "Get a job for a workflow run" endpoint that returns (in part):

    "status": {
      "description": "The phase of the lifecycle that the job is currently in.",
      "type": "string",
      "enum": [
        "queued",
        "in_progress",
        "completed"
      ],
      "examples": [
        "queued"
      ]
    },

Since Octokit.net has one model we share across these endpoints, your PR looks reasonable.

@kfcampbell kfcampbell moved this from 🆕 Triage to 👀 In review in 🧰 Octokit Active Jun 28, 2023
@vuryleo
Copy link
Contributor Author

vuryleo commented Jun 29, 2023

Yes, however, in my case it's just returning as a response from a get a workflowjob API. Perhaps the document is kind of outdated.

@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in 🧰 Octokit Active Jun 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage This is being looked at and prioritized Type: Bug Something isn't working as documented
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants