Skip to content

Commit

Permalink
Update README for lack of bundling in future GoCD
Browse files Browse the repository at this point in the history
  • Loading branch information
chadlwilson authored Jan 7, 2023
1 parent 8fd8992 commit f6d705d
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Yum repository poller plugin for GoCD

The Yum respository poller is a bundled [package material](https://docs.gocd.org/current/extension_points/package_repository_extension.html) plugin capable of polling yum repositories for rpm packages. GoCD server interacts with this plugin via package material plugin interfaces. The plugin makes use of a command similar to the following to poll the server. So it does not depend on the files that yum depends on e.g. files under `/etc/yum.repos.d`
The Yum respository poller is a [package material](https://docs.gocd.org/current/extension_points/package_repository_extension.html) plugin capable of polling yum repositories for rpm packages. GoCD server interacts with this plugin via package material plugin interfaces. The plugin makes use of a command similar to the following to poll the server. So it does not depend on the files that yum depends on e.g. files under `/etc/yum.repos.d`

```
repoquery --repofrompath=uuid,$REPO_URL --repoid=uuid -q $PACKAGE_SPEC -qf "%{LOCATION}..."
Expand All @@ -10,7 +10,10 @@ A given instance of polling is considered successful if `repoquery` returns a si

## Installation

This plugin comes bundled along with the GoCD server, hence a separate installation is not required.
From GoGCD `23.1.0` onwards, you should download the latest release jar and install into your server's `plugins/external` directory
per the [plugin user guide](https://docs.gocd.org/current/extension_points/plugin_user_guide.html).

Prior to GoCD `23.1.0`, this plugin came bundled along with the GoCD server, and a separate installation is not required.

> **Note:** This plugin is available for GoCD servers running on Linux nodes having `repoquery` installed using the [`yum-utils`](http://linux.die.net/man/1/yum-utils) package, [Ubuntu](http://manpages.ubuntu.com/manpages/latest/man1/yum-utils.1.html), [CentOS](http://rpmfind.net/linux/rpm2html/search.php?query=yum-utils&system=centos))
Expand All @@ -20,7 +23,7 @@ Repo URL must be a valid http, https or file URL. This plugin looks for the pres

## Package definition

In case of this plugin, the package definition is completely determined by the package spec. The package spec may be in any of the following formats. Please refer the [repoquery man page](https://linux.die.net/man/1/repoquery) for details.
In case of this plugin, the package definition is completely determined by the package spec. The package spec may be in any of the following formats. Please refer to the [repoquery man page](https://linux.die.net/man/1/repoquery) for details.

```
name
Expand Down

0 comments on commit f6d705d

Please sign in to comment.