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

initial feature add #1986

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

gitPushPuppets
Copy link

Description

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

private boolean compareUsePaginatedCommits;

private Set<GHRepositoryCustomProperty> custom_properties;
Copy link
Member

@bitwiseman bitwiseman Dec 5, 2024

Choose a reason for hiding this comment

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

Thoughts: I'm not sure that Set helps you here. You might want to represent this as

  • List - getting all of them
  • Map<String, String> - the docs seem to indicate that you can't have multiple properties with the same name value on a repository or organization. And the properties are just name/value pairs...
  • Map<String,CustomProperty> - This might be a good choice for future proofing, in case GitHub decides to make CustomProperty records more complex in future.

For either of the Map options you need to check whether key value uniqueness case-insensitive, case-sensitive but restricted to ASCII, or literary any Unicode/UTF-8 String.

I mean this as a discussion. I'm fully open to changing my mind.

Copy link
Author

Choose a reason for hiding this comment

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

I got my custom properties returned to me using this code base referenced in a console app.

I was discussing map options with a friend of mine but haven't been able to get it to work yet. I am not familiar with how this repo handles object mapping and kept running into null errors.

Copy link
Member

Choose a reason for hiding this comment

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

We use Jackson.

Give an example of where you get null errors and we'll see if we can figure it out.

@bitwiseman
Copy link
Member

Looks reasonable. Only one comment so far.

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.

2 participants