How to specify the Github Api endpoint?

[fml2]

Hello,

we'd like to use the plugin for creating Github releases in our company-internal installation of Github, i.e. not on github.com. Hence, the REST-API would be a custom one.

In the README to the plugin, it says

apiEndpoint (unused): Override the default API endpoint. Default: https://api.github.com

Is it possible (and how) to specify a custom endpoint for the Github REST API?

Thank you!

[boxheed]

@fml2 the apiEndpont configuration at this point in time is to make this plugin's configuration compatible with the https://plugins.gradle.org/plugin/com.github.breadmoirai.github-release plugin for an easy migration away from it. You have come across one gap in the functionality of this plugin. It shouldn't be too hard to implement though and if you want to have a go then feel free to submit a pull request. As a pointer this plugin uses the https://hub4j.github.io/github-api/ library to interact with Github, and if you look at line 16 of the GithubReleaseTaskResolvers.groovy file you will see it create the connection in the github function:

    public static def github(def context, def extension) {
        def token = resolve(extension.token)
        context.token = token
        context.github = GitHub.connectUsingOAuth(token)
        return context
    }

It is this function that will need to be updated create the connection based on the apiEndpoint configuration.

[boxheed]

@fml2 I assume you have Github Enterprise (can you confirm whether that is the case) then I think that you will need to use the connectToEnterpriseWithOAuth method on the Github class https://hub4j.github.io/github-api/apidocs/org.kohsuke.github.api/org/kohsuke/github/GitHub.html#connectToEnterpriseWithOAuth(java.lang.String,java.lang.String,java.lang.String).

[fml2]

Thank you for the quick reply! For now, I just wanted to have something that "just works" and hence have used the https://plugins.gradle.org/plugin/com.github.breadmoirai.github-release. If I won't be satisified with it, I'll have a look into this again.

Thank you once again for your work!

[boxheed]

@fml2 just to let you know I have updated the plugin to support the specification of the endpoint. The latest release 3.1.0 should have the feature in as well as a few variations on the authentication mechanism. As I don't have access to a Github Enterprise server so the changes are a little bit theoretical, I'd be interested to know if my changes work if you want to give it a try.

As an aside I know I pointed you at the breadmoirai plugin but I couldn't remember why I created this plugin instead so went and had a look at the breadmoirai repository. The following were two red flags which put me off using it:

1. The repository itself has no tags or releases so you cannot link the version that is on the Gradle plugin portal to the source code in the repository - in fact there are no guarantees that the latest source in the repo is the version in the plugin portal.
2. The plugin is not being actively maintained and it's dependencies are out of date and contain vulnerabilities see Update Okhttp version to fix security vulnerability BreadMoirai/github-release-gradle-plugin#71

If you want support in trying my plugin let me know and I'll keep this issue open.

[fml2]

@boxheed thank you for implementing this feature! I'll try to find time to try it out and report back. This can however last a couple of days because I'm "under load" now.