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

Implement method to check, if vulnerability alerts are enabled #1923

Merged
merged 3 commits into from
Sep 3, 2024

Conversation

ihrigb
Copy link
Contributor

@ihrigb ihrigb commented Sep 3, 2024

Description

This adds a method to GHRepository to check if vulnerability alerts are enabled. (https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#check-if-vulnerability-alerts-are-enabled-for-a-repository)

Fixes #1915

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

Copy link

codecov bot commented Sep 3, 2024

Codecov Report

Attention: Patch coverage is 75.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 81.36%. Comparing base (338de9a) to head (3056a0b).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/main/java/org/kohsuke/github/GHRepository.java 75.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1923      +/-   ##
============================================
- Coverage     81.36%   81.36%   -0.01%     
- Complexity     2464     2465       +1     
============================================
  Files           239      239              
  Lines          7471     7475       +4     
  Branches        401      402       +1     
============================================
+ Hits           6079     6082       +3     
  Misses         1146     1146              
- Partials        246      247       +1     

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

@bitwiseman
Copy link
Member

Interesting. Code coverage marked partial coverage because you only checked the success path. I'm okay with this.

@bitwiseman bitwiseman merged commit e62a7aa into hub4j:main Sep 3, 2024
11 of 12 checks passed
@ihrigb
Copy link
Contributor Author

ihrigb commented Sep 3, 2024

Interesting. Code coverage marked partial coverage because you only checked the success path. I'm okay with this.

Makes sence. The expression sth == sth is essentially a condition with two possible branches.

@ihrigb ihrigb deleted the dev/vulnerability-alerts branch September 3, 2024 21:30
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.

Support /repos/{owner}/{repo}/vulnerability-alerts
2 participants