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

feat: add ability to add checks with app ids #1844

Merged
merged 7 commits into from
Jun 15, 2024

Conversation

tginiotis-at-work
Copy link
Contributor

@tginiotis-at-work tginiotis-at-work commented May 16, 2024

Description

Fixes #1467

Add ability to receive and specify App IDs for required checks in branch protection rules.

Before submitting a PR:

  • 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.
  • Add JavaDocs and other comments explaining the behavior.
  • 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.
  • 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:

  • 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."
  • Enable "Allow edits from maintainers".

@tginiotis-at-work tginiotis-at-work force-pushed the app_ids_for_checks branch 3 times, most recently from 40b3783 to 78778a2 Compare May 16, 2024 10:35
@tginiotis-at-work tginiotis-at-work marked this pull request as ready for review May 17, 2024 14:10
@bitwiseman bitwiseman self-assigned this May 18, 2024
@bitwiseman bitwiseman self-requested a review May 18, 2024 19:09
@bitwiseman bitwiseman removed their assignment May 18, 2024
Copy link

codecov bot commented Jun 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.70%. Comparing base (c5ce1f6) to head (995bee2).
Report is 8 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1844      +/-   ##
============================================
+ Coverage     80.64%   80.70%   +0.06%     
- Complexity     2358     2363       +5     
============================================
  Files           225      225              
  Lines          7203     7221      +18     
  Branches        395      395              
============================================
+ Hits           5809     5828      +19     
+ Misses         1149     1148       -1     
  Partials        245      245              

☔ 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.

Minor tweaks. Thanks!

Comment on lines 565 to 570
private StatusChecks getStatusChecks() {
if (statusChecks == null) {
statusChecks = new StatusChecks();
statusChecks = new StatusChecksWithAppId();
}
return statusChecks;
}
Copy link
Member

Choose a reason for hiding this comment

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

Suggest something like this:

    <T extends StatusCheck> T getStatusChecks(Class<T> clazz) {
        if (statusChecks == null) {
            try {
                statusChecks = clazz.getDeclaredConstructor().newInstance();
            } catch (Exception ignored) {
            }
        }
        if (!clazz.isInstance(statusChecks) {
            throw new GHException("Cannot use checks and context status checks");
        } 
        return (T) statusChecks;
    }

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Apparently the deprecated API can be implemented in the new API. From the docs:
image

I underlined the same logic between the old and new API.

I.e. you need to omit the app_id field to do it the old way. I've added the @JsonInclude(JsonInclude.Include.NON_NULL) to instruct jackson to omit it in that case, and a comment explaining the special "app_id" values.

So I committed a change which allows the use of both the old and new user methods at the same time, preserving both their effects.

How does that look to you?

@bitwiseman bitwiseman merged commit 58c5976 into hub4j:main Jun 15, 2024
11 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.

GHBranchProtection using deprecated field in required_status_checks
2 participants