New Plugin With Multiple Components Hosting Question

[Mark Diesburg]

We will be submitting a new Jenkins plugin very shortly to integrate Jenkins into one of our products. Before pushing the plugin source to GitHub and starting the process we have a question on what should be submitted to the jenkinsci for hosting

 

Our Jenkins plugin is comprised of three main Java components. These are separate components because they are each separately useful and extensible. The rest-client component is the starting point for potentially building a complete standalone Java client that can be used to directly interact with our products REST API. The reporting-tool can be used to submit automation results to our product from anywhere without requiring customers to write their own JUnit/xUnit parser to do so. As a result, they are effectively dependencies that the actual Jenkins plugin uses to accomplish the desired plugin integration.

 

The summary of the components is:

• A rest-client component
  • Capable of connecting to, sending HTTP calls to, and interpreting results from our product’s REST API.
• A reporting-tool component
  • Responsible for taking in report files, parsing them, and converting their data into objects that can be sent to the rest-client to submit the build data using the rest-client to handle interacting with our products REST API.
• A test-management plugin component
  • The actual “plugin” portion of the Jenkins plugin.
  • Responsible for handling configuring the integration within Jenkins.
  • Captures output from runs in Jenkins and uses the reporting-tool component parse the data and then submit build results to our product.

 

We could submit just the source for the test-management plugin portion with reference to the other two components on GitHub since they can be used independently for other purposes.

 

Would this be acceptable?

 

Or would we have to submit all three components and also host the rest-client and reporting-tool components separately on GitHub in case someone wanted to use them for other purposes?

 

Thanks for any input!

[Tim Jacomb]

Hi

All libraries used in a plugin must be published publicly, open source approved license, and to an artifact repository that anyone can pull from normally either maven central or Jenkins repository.

Basically we can host it or you can push it to maven central if it makes sense outside of Jenkins

Thanks

Tim

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-de...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/17390df4-6af9-4c0e-a214-93d41deaf80dn%40googlegroups.com.

[Daniel Beck]

On Thu, Jun 30, 2022 at 8:55 PM Mark Diesburg <dies...@gmail.com> wrote:

We could submit just the source for the test-management plugin portion with reference to the other two components on GitHub since they can be used independently for other purposes.

 Would this be acceptable?

 Or would we have to submit all three components and also host the rest-client and reporting-tool components separately on GitHub in case someone wanted to use them for other purposes?

If you have general purpose libraries, those artifacts are best hosted e.g. on Maven Central. I think GH packages need authentication to download, making their use slightly inconvenient.

General purpose libraries deployed to the Jenkins Maven repo does not really make sense, as we do not support its use as a general purpose Maven repository.