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

Added all possible status values from GH api spec. #1885

Merged
merged 2 commits into from
Jul 1, 2024

Conversation

mpetris
Copy link
Contributor

@mpetris mpetris commented Jun 27, 2024

Added all possible github workflow run status values specified in https://docs.github.com/en/rest/actions/workflow-runs?apiVersion=2022-11-28

Description

The Github REST API allows more values than available in the Status enum for GitWorkflowRuns.

Before submitting a PR:

  • [x ] Changes must not break binary backwards compatibility. If you are unclear on how to make the change you think is needed while maintaining backward compatibility, CONTRIBUTING.md for details.
  • [ x] Add JavaDocs and other comments explaining the behavior.
  • [ x] When adding or updating methods that fetch entities, add @link JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .
  • Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See CONTRIBUTING.md for details.
  • [x ] Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.
  • Push your changes to a branch other than main. You will create your PR from that branch.

When creating a PR:

  • [ x] Fill in the "Description" above with clear summary of the changes. This includes:
    • If this PR fixes one or more issues, include "Fixes #" lines for each issue.
    • Provide links to relevant documentation on https://docs.github.com/en/rest where possible. If not including links, explain why not.
  • All lines of new code should be covered by tests as reported by code coverage. Any lines that are not covered must have PR comments explaining why they cannot be covered. For example, "Reaching this particular exception is hard and is not a particular common scenario."
  • [x ] Enable "Allow edits from maintainers".

Copy link

codecov bot commented Jun 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.05%. Comparing base (e8c6beb) to head (5a4a53e).
Report is 7 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1885      +/-   ##
============================================
+ Coverage     80.79%   81.05%   +0.25%     
- Complexity     2417     2442      +25     
============================================
  Files           233      237       +4     
  Lines          7264     7342      +78     
  Branches        398      398              
============================================
+ Hits           5869     5951      +82     
+ Misses         1148     1145       -3     
+ Partials        247      246       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@bitwiseman bitwiseman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR exposes a hole in our Enum tests - which should require that at least we have a known count of enum values. Please add this enum to https://github.com/hub4j/github-api/blob/main/src/test/java/org/kohsuke/github/EnumTest.java

😭 It would be great to have tests that actually use any of these values.

@bitwiseman bitwiseman merged commit 895ddce into hub4j:main Jul 1, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants