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

Fix visibility when creating a repository #1692

Merged
merged 5 commits into from
Aug 15, 2023

Conversation

dbaur
Copy link
Contributor

@dbaur dbaur commented Aug 10, 2023

Description

Fixes #1456.

Calls toString method on the visibility enum in GHRepositoryBuilder ensuring the correct value in the request.

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

@codecov
Copy link

codecov bot commented Aug 10, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.04% 🎉

Comparison is base (c283716) 80.04% compared to head (f4322fe) 80.08%.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1692      +/-   ##
============================================
+ Coverage     80.04%   80.08%   +0.04%     
- Complexity     2231     2233       +2     
============================================
  Files           215      215              
  Lines          6760     6760              
  Branches        365      365              
============================================
+ Hits           5411     5414       +3     
+ Misses         1134     1132       -2     
+ Partials        215      214       -1     
Files Changed Coverage Δ
...n/java/org/kohsuke/github/GHRepositoryBuilder.java 90.90% <100.00%> (+9.09%) ⬆️

... and 1 file with indirect coverage changes

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

@dbaur dbaur marked this pull request as ready for review August 10, 2023 07:53
@dbaur
Copy link
Contributor Author

dbaur commented Aug 10, 2023

One remark:

The issue also mentions that for some requests the repository is created with the wrong visibility. I think that this is due to GitHub API differentiating between the "visibility" field and the "private" field in its API.

When creating a repository for a user (i.e. not in an organization) and setting the visibility to "Visibility.PRIVATE" it seems that the API ignores the visibility setting if not also the _private method on the builder is set to true.

This can lead to confusing results, since one typically expects the visibility of the repository to be private when setting the visibility setting.

However, I am not sure if it is in the scope of this project to fix this problem of the GitHub API.

@bitwiseman bitwiseman merged commit a84a000 into hub4j:main Aug 15, 2023
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.

Creating a Repo with a Visibility Fails
2 participants