isabella232 / go-maven-poller

Go CD plugin that polls Maven repositories including Artifactory and Nexus

Go Maven Poller

This is a Maven repository package plugin for the Go CD continuous integration server and a remix of the aresok's codebase. The major differences are:

• Building with Maven instead of Ant
• Added proxy option to repository configuration
• This plugin parses the maven-metadata.xml of a Maven repository instead of using the Nexus API and therefore can be used for a broader range of Artifactory and Nexus repositories.
• Use of GoCD JSON API

Tested on following repositories:

• Maven Central (Link)
• JBoss Nexus (Link)
• Bintray jCenter (Link)
• Artifactory (Link)

Requirements

The go-maven-poller requires at least the following environment:

• GoCD 17.4.0 and later
• JDK 8 - 12 and later (the JDK GoCD is running with)

Installation

Download go-maven-poller-plugin.jar into the plugins/external directory of your GoCD server and restart it.

You can also download a signed jar from the maven repository and verify the GPG signature with my GPG public key.

Repository definition

Repo URL must be a valid http or https URL. Basic authentication (user:password@host/path) is supported. You may specify a proxy. If your GoCD server system doesn't use the same timezone as the repository, you may set a specific time zone. If 'Latest version Tag' is specified, the value of it will be used to determine, if new version is available. It will be not compared to other versions of the package.

Package definition

Group Id and Artifact Id refer to the corresponding entries in pom.xml. Click check package to make sure the plugin understands what you are looking for. You may set lower and upper version bounds to further narrow down the versions you want to look for.

Published Environment Variables

The following information is made available as environment variables for tasks:

GO_PACKAGE_<REPO-NAME>_<PACKAGE-NAME>_LABEL
GO_REPO_<REPO-NAME>_<PACKAGE-NAME>_REPO_URL
GO_PACKAGE_<REPO-NAME>_<PACKAGE-NAME>_GROUP_ID
GO_PACKAGE_<REPO-NAME>_<PACKAGE-NAME>_ARTIFACT_ID
GO_PACKAGE_<REPO-NAME>_<PACKAGE-NAME>_PACKAGING
GO_PACKAGE_<REPO-NAME>_<PACKAGE-NAME>_LOCATION

The GO_PACKAGE_..._LOCATION variable points to a downloadable url.

Downloading the Package

To download the package locally on the agent, we could write a curl (or wget) task like this:

            <exec command="/bin/bash" >
            <arg>-c</arg>
            <arg>curl -o /tmp/mypkg.jar $GO_PACKAGE_REPONAME_PKGNAME_LOCATION</arg>
            </exec>

When the task executes on the agent, the environment variables get substituted and the package gets downloaded.

Notes

This plugin will detect at max one package revision per minute (the default interval at which Go materials poll). If multiple versions of a package get published to a repo in the time interval between two polls, Go will only register the latest version in that interval.