hub4j / github-api

Java API for GitHub
https://github-api.kohsuke.org/
MIT License
1.12k stars 718 forks source link

Code Scanning API support #1787

Open wwong opened 5 months ago

wwong commented 5 months ago

Description

Following up on open comments from https://github.com/hub4j/github-api/pull/1142 and https://github.com/cortexapps/github-api/pull/8

I don't currently have access to the security alerts for the example test repo (https://github.com/hub4j-test-org/Pixi), so the response fields might be slightly outdated until I (or someone else) can re-record the wiremock samples.

Start of an (incomplete) implementation for https://github.com/hub4j/github-api/issues/1133 (will add more endpoints in a later PR)

This change adds the read-only calls for the following endpoints, as they were originally implemented in previous PRs:

Before submitting a PR:

When creating a PR:

wwong commented 5 months ago

Hi @bitwiseman, tagging you here because you're the only member of the hub4j org that I can see.

When you get the chance, could you approve the test workflows on this PR? The tests are passing locally, but I want to make sure things are all good in CI before I open up for review. It'd also be great to get access to the security alerts in the hub4j-test-org so that I can refresh the wiremock snapshots. Thanks!

bitwiseman commented 5 months ago

@wwong I'm inviting you to the hub4j-test-org now.

codecov[bot] commented 5 months ago

Codecov Report

Attention: Patch coverage is 78.94737% with 24 lines in your changes missing coverage. Please review.

Project coverage is 81.02%. Comparing base (895ddce) to head (1e9c381). Report is 1 commits behind head on main.

Files Patch % Lines
...rg/kohsuke/github/GHCodeScanningAlertInstance.java 52.27% 9 Missing and 12 partials :warning:
...e/github/GHCodeScanningAlertInstancesIterable.java 92.30% 0 Missing and 1 partial :warning:
...g/kohsuke/github/GHCodeScanningAlertsIterable.java 93.33% 0 Missing and 1 partial :warning:
src/main/java/org/kohsuke/github/GHRepository.java 88.88% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1787 +/- ## ============================================ - Coverage 81.05% 81.02% -0.04% - Complexity 2442 2476 +34 ============================================ Files 237 242 +5 Lines 7342 7456 +114 Branches 398 412 +14 ============================================ + Hits 5951 6041 +90 - Misses 1145 1155 +10 - Partials 246 260 +14 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

wwong commented 5 months ago

@bitwiseman Thanks! I'll see if I can find some time this weekend to shore up the code coverage and add some more support for the rest of the Code Scanning endpoints.

bitwiseman commented 2 weeks ago

@wwong If/When you get back to this PR, please pull the changes I've applied and avoid force pushes to make reviewing easier.

wwong commented 2 weeks ago

Will do, thanks @bitwiseman. Life is a little busy right now, but I hope to get back to this soon, maybe in the next couple weeks.

In the process of integrating these changes in a work project, I also found some areas for improvement in the proposed code scanning interfaces, which I'll also try to incorporate before finalizing the PR.