The Properties module supplies a wide range of options that are implemented as Jenkins job properties.
Macro: | property |
---|---|
Entry Point: | jenkins_jobs.properties |
Example:
job:
name: test_job
properties:
- github:
url: https://github.com/openstack-ci/jenkins-job-builder/
Specifies an authorization matrix where only authenticated users may trigger a build.
DEPRECATED
Example:
properties:
- authenticated-build
Specifies an authorization matrix
Example:
properties:
- authorization:
admin:
- job-delete
- job-configure
- job-read
- job-discover
- job-build
- job-workspace
- job-cancel
- run-delete
- run-update
- scm-tag
anonymous:
- job-discover
- job-read
Creates an extended choice property where values can be read from a file Requires the Jenkins Extended Choice Parameter Plugin.
Parameters: |
|
---|
Example:
properties:
- extended-choice:
name: FOO
description: A foo property
property-file: /home/foo/property.prop
property-key: key
quote-value: true
visible-items: 10
type: multi-select
value: foo,bar,select
default-value: foo
default-property-file: /home/property.prop
default-property-key: fookey
Sets the GitHub URL for the project.
Parameters: | url (str) – the GitHub URL |
---|
Example:
properties:
- github:
url: https://github.com/openstack-ci/jenkins-job-builder/
Allows you to inject evironment variables into the build. Requires the Jenkins Env Inject Plugin.
Parameters: |
|
---|
Example:
properties:
- inject:
properties-content: FOO=bar
Marks a build for promotion. A promotion process with an identical name must be created via the web interface in the job in order for the job promotion to persist. Promotion processes themselves cannot be configured by jenkins-jobs due to the separate storage of plugin configuration files. Requires the Jenkins Promoted Builds Plugin.
Parameters: | names (list) – the promoted build names |
---|
Example:
properties:
- promoted-build:
names:
- "Release to QA"
- "Jane Must Approve"
Throttles the number of builds for this job. Requires the Jenkins Throttle Concurrent Builds Plugin.
Parameters: |
|
---|
Example:
properties:
- throttle:
max-total: 4
categories:
- cat1
- cat2