8.5 KiB

Raw Blame History

title: Pagure Driver

Pagure

The Pagure driver supports sources, triggers, and reporters. It can interact with the public Pagure.io service as well as site-local installations of Pagure.

Configure Pagure

The user's API token configured in zuul.conf must have the following ACL rights:

"Merge a pull-request" set to on (optional, only for gating)
"Flag a pull-request" set to on
"Comment on a pull-request" set to on
"Modify an existing project" set to on

Each project to be integrated with Zuul needs:

"Web hook target" set to http://<zuul-web>/zuul/api/connection/<conn-name>/payload
"Pull requests" set to on
"Open metadata access to all" set to off (optional, expected if approval based on PR a metadata tag)
"Minimum score to merge pull-request" set to the same value than the score requierement (optional, expected if score requierement is defined in a pipeline)

Furthermore, the user must be added as project collaborator (ticket access level), to be able to read the project's webhook token. This token is used to validate webhook's payload. But if Zuul is configured to merge pull requests then the access level must be commit.

Connection Configuration

The supported options in zuul.conf connections are:

driver

pagure

The connection must set driver=pagure for Pagure connections.

api_token

The user's API token with the Modify an existing project capability.

server

Hostname of the Pagure server.

canonical_hostname

The canonical hostname associated with the git repos on the Pagure server. Defaults to the value of <pagure connection>.server. This is used to identify projects from this connection by name and in preparing repos on the filesystem for use by jobs. Note that Zuul will still only communicate with the Pagure server identified by server; this option is useful if users customarily use a different hostname to clone or pull git repos so that when Zuul places them in the job's working directory, they appear under this directory name.

baseurl

Path to the Pagure web and API interface.

cloneurl

Path to the Pagure Git repositories. Used to clone.

app_name

Display name that will appear as the application name in front of each CI status flag.

source_whitelist

A comma separated list of source ip adresses from which webhook calls are whitelisted. If the source is not whitelisted, then call payload's signature is verified using the project webhook token. An admin access to the project is required by Zuul to read the token. White listing a source of hook calls allows Zuul to react to events without any authorizations. This setting should not be used in production.

Trigger Configuration

Pagure webhook events can be configured as triggers.

A connection name with the Pagure driver can take multiple events with the following options.

pipeline.trigger.<pagure source>

The dictionary passed to the Pagure pipeline trigger attribute supports the following attributes:

event

The event from Pagure. Supported events are:

pg_pull_request

pg_pull_request_review

pg_push

action

A pipeline.trigger.<pagure source>.event.pg_pull_request event will have associated action(s) to trigger from. The supported actions are:

opened

Pull request opened.

changed

Pull request synchronized.

closed

Pull request closed.

comment

Comment added to pull request.

status

Status set on pull request.

tagged

Tag metadata set on pull request.

A pipeline.trigger.<pagure source>.event.pg_pull_request_review event will have associated action(s) to trigger from. The supported actions are:

thumbsup

Positive pull request review added.

thumbsdown

Negative pull request review added.

comment

This is only used for pg_pull_request and comment actions. It accepts a list of regexes that are searched for in the comment string. If any of these regexes matches a portion of the comment string the trigger is matched. comment: retrigger will match when comments containing 'retrigger' somewhere in the comment text are added to a pull request.

status

This is used for pg_pull_request and status actions. It accepts a list of strings each of which matches the user setting the status, the status context, and the status itself in the format of status. For example, success or failure.

tag

This is used for pg_pull_request and tagged actions. It accepts a list of strings and if one of them is part of the event tags metadata then the trigger is matched.

ref

This is only used for pg_push events. This field is treated as a regular expression and multiple refs may be listed. Pagure always sends full ref name, eg. refs/tags/bar and this string is matched against the regular expression.

Reporter Configuration

Zuul reports back to Pagure via Pagure API. Available reports include a PR comment containing the build results, a commit status on start, success and failure, and a merge of the PR itself. Status name, description, and context is taken from the pipeline.

pipeline.<reporter>.<pagure source>

To report to Pagure, the dictionaries passed to any of the pipeline reporter<reporters> attributes support the following attributes:

status

String value (pending, success, failure) that the reporter should set as the commit status on Pagure.

status-url

String value for a link url to set in the Pagure status. Defaults to the zuul server status_url, or the empty string if that is unset.

comment

Boolean value that determines if the reporter should add a comment to the pipeline status to the Pagure Pull Request. Only used for Pull Request based items.

merge

Boolean value that determines if the reporter should merge the pull Request. Only used for Pull Request based items.

Requirements Configuration

As described in pipeline.require pipelines may specify that items meet certain conditions in order to be enqueued into the pipeline. These conditions vary according to the source of the project in question. To supply requirements for changes from a Pagure source named pagure, create a configuration such as the following:

pipeline:
  require:
    pagure:
      score: 1
      merged: false
      status: success
      tags:
        - gateit

This indicates that changes originating from the Pagure connection must have a score of 1, a CI status success and not being already merged.

pipeline.require.<pagure source>

The dictionary passed to the Pagure pipeline require attribute supports the following attributes:

score

If present, the minimal score a Pull Request must reached.

status

If present, the CI status a Pull Request must have.

merged

A boolean value (true or false) that indicates whether the Pull Request must be merged or not in order to be enqueued.

open

A boolean value (true or false) that indicates whether the Pull Request must be open or closed in order to be enqueued.

Reference pipelines configuration

Here is an example of standard pipelines you may want to define:

/examples/pipelines/pagure-reference-pipelines.yaml

8.5 KiB Raw Blame History

Pagure

Configure Pagure

Connection Configuration

Trigger Configuration

Reporter Configuration

Requirements Configuration

Reference pipelines configuration

8.5 KiB

Raw Blame History