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]: Missing workflow run conclusions #2684

Closed
1 task done
ezhevita opened this issue Mar 19, 2023 · 1 comment · Fixed by #2685
Closed
1 task done

[BUG]: Missing workflow run conclusions #2684

ezhevita opened this issue Mar 19, 2023 · 1 comment · Fixed by #2685
Labels
Status: Triage This is being looked at and prioritized Type: Bug Something isn't working as documented

Comments

@ezhevita
Copy link
Contributor

What happened?

Our company has a service that is grabbing GitHub workflow run data and then store it locally for further analysis. However the library was throwing exceptions for some of those workflow runs with the message Value 'startup_failure' is not a valid 'WorkflowRunConclusion' enum value. I've checked the source code of Octokit.NET and it wasn't there indeed, so I've checked GitHub API reference to make sure this is properly documented. However, all of the REST API documentation doesn't mention this conclusion anywhere (Using the REST API to interact with checks, Check Runs REST API, Workflow runs REST API, Creating CI tests with the Checks API) and the only place this conclusion is mentioned is in GraphQL reference.

I have prepared a branch with the fix to the library (however the GitHub documentation is still broken), so the pull request should follow shortly after the issue.

also misc: the Code of Conduct link is broken in the issue template and actually is leading to issues :p

Versions

Octokit.Net 4.0.2, .NET 6.0.14

Relevant log output

System.ArgumentException: Value 'startup_failure' is not a valid 'WorkflowRunConclusion' enum value.
  File "/home/runner/work/octokit.net/octokit.net/Octokit/Models/Response/StringEnum.cs", line 146, col 17, in ParseValue
  File "/home/runner/work/octokit.net/octokit.net/Octokit/Models/Response/StringEnum.cs", line 45, col 19, in get_Value
  ... application stacktrace ...

Code of Conduct

  • I agree to follow this project's Code of Conduct
@ezhevita ezhevita added Status: Triage This is being looked at and prioritized Type: Bug Something isn't working as documented labels Mar 19, 2023
@nickfloyd
Copy link
Contributor

Hey @ezhevita, thanks for the double catch and thoroughness and follow-through on checking the API docs.

This is one of those cases where we have to go to the GitHub OpenAPI definitions to validate the enum - which startup_failure is included in that set.

It's a great call out that I'll bring up to our OpenAPI working group to see if these types of enums can get better representation in our docs.

@github-project-automation github-project-automation bot moved this from 🆕 Triage to ✅ Done in 🧰 Octokit Active Mar 24, 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