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.

Sign up for GitHub

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

Jump to bottom

Publish "nobridge" version of the library #1742

Closed
wants to merge 2 commits into from
Closed

Publish "nobridge" version of the library #1742

wants to merge 2 commits into from

Conversation

bitwiseman
Copy link
Member

Description

Converts the project to a multi-module structure and adds a new "No Bridge" build output.

  • Multi-module - allows us to produce more than one flavor of library based on the same code.
  • "No Bridge" build flavor - compiles the library without generating bridge methods. This flavor of the library does NOT guarantee binary backward compatibility. However, it does unblock mocking ( fixes Unable to mock GHObject#id #1739 ).

Multi-module will also allow us to begin producing a v2 beta flavor without breaking the consumers of the v1 line.

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

@bitwiseman
Copy link
Member Author

@gsmet @Haarolean
Do you think you could try this out and see if it helps with the mocking issue?

@Haarolean
Copy link
Contributor

@bitwiseman sure, thank you! Will take a look

@codecov Codecov
Copy link

codecov bot commented Nov 15, 2023 •
edited

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (40992f7) 80.16% compared to head (eaf5a4f) 0.00%.

❗ Current head eaf5a4f differs from pull request most recent head 80d2b6a. Consider uploading reports for the commit 80d2b6a to get more accurate results

Additional details and impacted files 
@@             Coverage Diff              @@
##               main   #1742       +/-   ##
============================================
- Coverage     80.16%       0   -80.17%     
============================================
  Files           217       0      -217     
  Lines          6962       0     -6962     
  Branches        371       0      -371     
============================================
- Hits           5581       0     -5581     
+ Misses         1150       0     -1150     
+ Partials        231       0      -231

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

@bitwiseman bitwiseman force-pushed the multi-module branch 2 times, most recently from 4be85c9 to eaf5a4f Compare November 15, 2023 19:28
Haarolean
Haarolean reviewed Nov 16, 2023
View reviewed changes
github-api-nobridge/pom.xml
@@ -0,0 +1,306 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.kohsuke</groupId>
Copy link
Contributor

Choose a reason for hiding this comment

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

groupId declaration is redundant here due to the module being inherited from a parent

@Haarolean
Copy link
Contributor

@bitwiseman I can confirm that mocking objects works now. Thank you!

@bitwiseman bitwiseman mentioned this pull request Nov 17, 2023
Open
@bitwiseman
Copy link
Member Author

I'm going to make this a release/v1.x-nobridge branch instead of multimodule.

@bitwiseman bitwiseman closed this Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Haarolean Haarolean Haarolean left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Unable to mock GHObject#id
2 participants
@bitwiseman @Haarolean