Properties

The Properties module supplies a wide range of options that are implemented as Jenkins job properties.

Component: properties
Macro:property
Entry Point:jenkins_jobs.properties

Example:

job:
  name: test_job

  properties:
    - github:
        url: https://github.com/openstack-ci/jenkins-job-builder/
authenticated-build

Specifies an authorization matrix where only authenticated users may trigger a build.

DEPRECATED

Example:

properties:
  - authenticated-build
authorization

Specifies an authorization matrix

The available rights are:
job-delete job-configure job-read job-discover job-build job-workspace job-cancel run-delete run-update scm-tag

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
extended-choice

Creates an extended choice property where values can be read from a file Requires the Jenkins Extended Choice Parameter Plugin.

Parameters:
  • name (string) – name of the property
  • description (string) – description of the property (optional, default ‘’)
  • property-file (string) – location of property file to read from (optional, default ‘’)
  • property-key (string) – key for the property-file (optional, default ‘’)
  • quote-value (bool) – whether to put quotes around the property when passing to Jenkins (optional, default false)
  • visible-items (string) – number of items to show in the list (optional, default 5)
  • type (string) – type of select (optional, default single-select)
  • value (string) – comma separated list of values for the single select or multi-select box (optional, default ‘’)
  • default-value (string) – used to set the initial selection of the single-select or multi-select box (optional, default ‘’)
  • default-property-file (string) – location of property file when default value needs to come from a property file (optional, default ‘’)
  • default-property-key (string) – key for the default property file (optional, default ‘’)

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
github

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/
inject

Allows you to inject evironment variables into the build. Requires the Jenkins Env Inject Plugin.

Parameters:
  • properties-file (str) – file to read with properties (optional)
  • properties-content (str) – key=value properties (optional)
  • script-file (str) – file with script to run (optional)
  • script-content (str) – script to run (optional)
  • groovy-content (str) – groovy script to run (optional)
  • load-from-master (bool) – load files from master (default false)
  • enabled (bool) – injection enabled (default true)
  • keep-system-variables (bool) – keep system variables (default true)
  • keep-build-variables (bool) – keep build variable (default true)

Example:

properties:
  - inject:
      properties-content: FOO=bar
promoted-build

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"
throttle

Throttles the number of builds for this job. Requires the Jenkins Throttle Concurrent Builds Plugin.

Parameters:
  • max-per-node (int) – max concurrent builds per node (default 0)
  • max-total (int) – max concurrent builds (default 0)
  • enabled (bool) – whether throttling is enabled (default True)
  • option (str) – throttle project or category
  • categories (list) – multiproject throttle categories

Example:

properties:
  - throttle:
      max-total: 4
      categories:
        - cat1
        - cat2

Previous topic

Parameters

Next topic

Publishers

This Page