Configuration

Plumber is configurable using .github/plumber.yml. Configuration is required to allow Plumber to successfully run on repository.

Table of Contents

Example

Following example shows configuration for RHEL9 Source-git of package systemd.

# .github/plumber.yml
package: 'systemd'

config:
  - branch: 'main'
    release: 'c9s'
  - branch: 'rhel-9.0.0'
    release: '9.0.0'
  - branch: 'rhel-9.1.0'
    release: '9.1.0'

rules:
  bugzillaReference:
    label: 'needs-bz'
  review:
    label: 'needs-review'
  ci:
    label: 'needs-ci'
  upstreamReference:
    label: 'needs-upstream'
  flags:
    label: 'needs-flags'
    flags: ['qa_ack', 'devel_ack', 'release']

package

Name of package in RHEL corresponding to repository.

• Value: string
• Required

package: systemd

config

• Value: Array of objects
• Required

config:
  - branch: 'main'
    release: 'c9s'
  - branch: 'rhel-9.0.0'
    release: '9.0.0'

Property	O/R	Type	Note
branch	Required	string	Name of branch associated with RHEL/CS release.
release	Required	string	Name of release according to PP. For latest version use special keywords like c8s, c9s, etc.

rules

Rules object allows users to set a set of requirements for PRs opened against given branches. All rules are optional. List of supported rules and properties are listed below.

• Value: Array of objects
• Required

rules:
  review:
    label: 'needs-review'
    blocking: true

bugzillaReference

• Value: Object
• Optional

Property	O/R	Type	Default	Note
label	Optional	string	needs-bz	GitHub label that will be set if commits has wrong Bugzilla reference on reference is missing
blocking	Optional	boolean	true	Does this rule blocks merging of PR?

jiraReference

• Value: Object
• Optional

Property	O/R	Type	Default	Note
label	Optional	string	needs-jira	GitHub label that will be set if commits has wrong Jira reference on reference is missing
blocking	Optional	boolean	true	Does this rule blocks merging of PR?

review

• Value: Object
• Optional

Property	O/R	Type	Default	Note
label	Optional	string	needs-review	GitHub label that will be set if PR is not approved
blocking	Optional	boolean	true	Does this rule blocks merging of PR?

ci

• Value: Object
• Optional

Property	O/R	Type	Default	Note
label	Optional	string	needs-ci	GitHub label that will be set if required CI tests fails
blocking	Optional	boolean	true	Does this rule blocks merging of PR?

upstreamReference

• Value: Object
• Optional

Property	O/R	Type	Default	Note
label	Optional	string	needs-upstream	GitHub label that will be set if commits would miss upstream reference
blocking	Optional	boolean	true	Does this rule blocks merging of PR?

flags

• Value: Object
• Optional

Property	O/R	Type	Default	Note
label	Optional	string	needs-flags	GitHub label that will be set if required flags aren't set
blocking	Optional	boolean	true	Does this rule blocks merging of PR?
flags	Optional	string[]	['release', 'devel_ack', 'qa_ack']	Required Bugzilla/Jira flags