Support GitHub Enterprise #319

castler · 2025-03-19T13:07:42Z

GitHub can be hosted by companies for their own usage (under their own URL).
This changset removes the hard-coded url to github.com and makes it confligurable for a user, which GitHub-instances shall be supported.

Closes #134

castler · 2025-04-29T05:47:12Z

@mikelalcon @hsudhof

Sorry to bother.
Is there any chance of getting this, or similar versions, merged? Otherwise I would close the PR - to not have unfinished work.

Thanks for your feedback!

chris-campos · 2025-04-30T13:25:10Z

java/com/google/copybara/git/GitModule.java

+
+    boolean isGitHubUrl = false;
+    try{
+        GitHubOptions githubOptions = options.get(GitHubOptions.class);


could we move this outside of the try catch block?

chris-campos · 2025-04-30T13:32:26Z

java/com/google/copybara/git/GitModule.java

+        GitHubOptions githubOptions = options.get(GitHubOptions.class);
+        GitHubHost ghHost = githubOptions.getGitHubHost(url);
+        isGitHubUrl = ghHost.isGitHubUrl(url);
+    } catch (EvalException e) {


empty catch blocks are a bit of an anti-pattern, and I'd like to avoid having these if possible. is there any way you can refactor this into a method in GitHubOptions that returns whether a url belongs to one of the GH hosts?

if you must keep the empty catch block, please leave a comment explaining why we catch and swallow the exception

chris-campos · 2025-04-30T13:33:00Z

java/com/google/copybara/git/GitModule.java

+                  !ghHost.isGitHubUrl(url),
+                  "Git origins with github should use github approval providers!");
+      } catch(EvalException e){
+         // nothing to-do, apparently this is no GitHub URL.


same comments as above

chris-campos · 2025-04-30T13:34:16Z

java/com/google/copybara/git/github/api/GitHubApiTransportImpl.java

-  public GitHubApiTransportImpl(GitRepository repo, HttpTransport httpTransport,
-      String storePath, boolean bearerAuth, Console console) {
+  public GitHubApiTransportImpl(GitHubHost ghHost, GitRepository repo, HttpTransport httpTransport,
+                                String storePath, boolean bearerAuth, Console console) {


nit: extra whitespace

chris-campos · 2025-04-30T13:37:29Z

javatests/com/google/copybara/git/GitOriginTest.java

can we add a test that checks if a origin URL is considered a valid GitHub URL when that host is set as a GitHub host?

chris-campos

TY for the contribution! Please see line comments.

castler · 2025-05-06T18:48:56Z

Great, I will try to solve that in the next days!

castler · 2025-05-07T09:35:39Z

@chris-campos tried to apply your comments in:

https://github.com/google/copybara/compare/c3f828295d778da8104501c0bd2b0d8e9305eb11..3f870864744eb257048bbe6708ad95806a9f6357

chris-campos · 2025-05-12T18:53:55Z

java/com/google/copybara/git/GitHubOptions.java

+      names = "--github-allowed-hosts",
+      description = "If using GitHub Enterprise, one needs to specify valid hosts. By default only `github.com` is supported."
+  )
+  public List<String> gitHubAllowedHosts = ImmutableList.of("github.com");


Thinking about this more, I'm realizing that a flag to set the "allowed" GitHub hosts is not going to scale well for our internal use, and it might not be user friendly for our OSS users. We should avoid using a flag for setting the host allowlist.

I see why the flag was needed in the first place: git.origin was allowed to accept GitHub use cases, which in retrospect was not ideal. However, we also have git.github_origin (GitHub specific) in the module, which gives me an idea.

What if we make it so that git.github_origin assumes that the host in the URL is a valid GitHub host? i.e., if a user says the repo URL is foo.com, then we just treat it as if it has GitHub APIs?

As for the standard git.origin, github.com can be considered the only valid GitHub host. Therefore, Github enterprise specific origins should use git.github_origin

In this way, we are:

leveraging the user's intent in choosing github_origin to set it as a valid GitHub host as that is the most likely intent

preserving the existing behavior for legacy git.origin users.

what do you think? please LMK if you have any questions, and thank you again for working on this.

Understood - I am afraid of cases where no github specific function is available. I am not that familiar yet with CopyBara in order to judge this out of my head if such cases exist.

So I will give this a try in the next days.

@castler Hello!

I just wanted to follow up on this and how your progress is going on this change. We are really interested in adding this feature into Copybara.

If you can no longer work on it, do you mind if we clone your change and continue work on it? We are also happy to answer any questions you may have.

Thanks again for this great contribution thus far!

@chris-campos so sorry that I did not answer...I was now on vacation now for two weeks.

Apparently I got some work at my company todo. So if anybody wants to continue right now - feel free. Otherwise I can try to find some time next week hopefully.

Thank you, I will see if I can make the changes I suggested above.

chris-campos

Thanks for the code changes! Left one more comment about the added flag, LMK what you think

GitHub can be hosted by companies for their own usage (under their own URL). This changset removes the hard-coded url to `github.com` and makes it confligurable for a user, which GitHub-instances shall be supported. Closes google#134

To better support GitHub enterprise, the GitHub Origin will just assume any host it's given is a GitHub or Github enterprise host. GitOrigin will continue to accept GitHub.com URLs.

sainathseelam · 2025-11-21T09:56:06Z

Hi @castler and @chris-campos,

This PR is really important for GitHub Enterprise support in our workflow. It would be great to prioritize resolving the remaining comments and failing checks so it can be merged. Happy to help with testing or questions to get this done.

Thanks!

chris-campos · 2025-11-21T17:57:23Z

@sainathseelam Hi there! We are now working on this internally.

castler mentioned this pull request Mar 19, 2025

Github enterprise support #134

Open

mikelalcon requested review from chris-campos and hsudhof April 30, 2025 12:30

chris-campos reviewed Apr 30, 2025

View reviewed changes

chris-campos requested changes Apr 30, 2025

View reviewed changes

castler force-pushed the support_github_enterprise branch from c3f8282 to 3f87086 Compare May 7, 2025 09:34

chris-campos reviewed May 12, 2025

View reviewed changes

chris-campos self-assigned this Jul 22, 2025

chris-campos force-pushed the support_github_enterprise branch 2 times, most recently from 38c43aa to b635851 Compare July 28, 2025 21:35

chris-campos force-pushed the support_github_enterprise branch from b635851 to d7184da Compare August 1, 2025 19:29

castler and others added 2 commits August 4, 2025 13:33

Support GitHub Enterprise

c4f4a50

GitHub can be hosted by companies for their own usage (under their own URL). This changset removes the hard-coded url to `github.com` and makes it confligurable for a user, which GitHub-instances shall be supported. Closes google#134

Allow GitHub origin to accept any host

ea48ff4

To better support GitHub enterprise, the GitHub Origin will just assume any host it's given is a GitHub or Github enterprise host. GitOrigin will continue to accept GitHub.com URLs.

chris-campos force-pushed the support_github_enterprise branch from d7184da to ea48ff4 Compare August 4, 2025 17:33

Support GitHub Enterprise #319

Are you sure you want to change the base?

Support GitHub Enterprise #319

Uh oh!

Conversation

castler commented Mar 19, 2025

Uh oh!

castler commented Apr 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chris-campos left a comment

Choose a reason for hiding this comment

Uh oh!

castler commented May 6, 2025

Uh oh!

castler commented May 7, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chris-campos left a comment

Choose a reason for hiding this comment

Uh oh!

sainathseelam commented Nov 21, 2025

Uh oh!

chris-campos commented Nov 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants