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

Add GHOrganization.listSecurityManagers() #1832

Merged
merged 4 commits into from
Jun 17, 2024
Merged

Conversation

kozmic
Copy link
Contributor

@kozmic kozmic commented Apr 12, 2024

Description

Add support to list Security Managers in a GitHub Organization. See GitHub's API doc for this API for more details about this API.

Tests:

If I'm given access to the hub4j-test-org Org, including permission to create a team and configure that team as a Security Manager team (or someone else can set this up for me), I can include an integration test (I didn't find a step-by-step process in CONTRIBUTING.md to get this access.

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

Add support to list Security Managers in a GitHub Organization.
Copy link

@muhammedabdelkader muhammedabdelkader left a comment

Choose a reason for hiding this comment

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

LGTM!

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.

Please add a test for CI.

Copy link

codecov bot commented Apr 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.03%. Comparing base (c2ac4b0) to head (92112af).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #1832   +/-   ##
=========================================
  Coverage     81.03%   81.03%           
- Complexity     2409     2411    +2     
=========================================
  Files           233      233           
  Lines          7344     7347    +3     
  Branches        399      399           
=========================================
+ Hits           5951     5954    +3     
  Misses         1148     1148           
  Partials        245      245           

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

@kozmic
Copy link
Contributor Author

kozmic commented Apr 29, 2024

@bitwiseman : I would love to, but you need to add me to the test org so I can add a security maanger to run the tests against. Or is a unit test good enough for you?

From the description of this PR:

If I'm given access to the hub4j-test-org Org, including permission to create a team and configure that team as a Security Manager team (or someone else can set this up for me), I can include an integration test (I didn't find a step-by-step process in CONTRIBUTING.md to get this access.

@kozmic
Copy link
Contributor Author

kozmic commented Apr 29, 2024

@bitwiseman : I've added test response files that I've manually created and created unit tests based on those. Let me know if you want me to have real files from your test org, then you need to add me with permission to add a security team to the test org (or you can do it, and give me read access).

@kozmic
Copy link
Contributor Author

kozmic commented May 13, 2024

@bitwiseman : Could you take a look at this?

@bitwiseman bitwiseman self-requested a review June 17, 2024 01:51
@bitwiseman bitwiseman merged commit dd274c3 into hub4j:main Jun 17, 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.

4 participants