jenkins-job-resource

A Concourse resource for Jenkins jobs.

Example

resource_types:
  - name: jenkins-job-resource
    type: registry-image
    source:
      repository: ghcr.io/frantjc/jenkins-job-resource
      tag: latest
resources:
  - name: my-jenkins-job
    type: jenkins-job-resource
    source:
jobs:
  - name: some-job
    plan:
      - put: my-jenkins-job
        params:
          cause: some-job in Concourse caused this build
          build_params:
            foo: bar
  - name: another-job
    plan:
      - get: my-jenkins-job

Source Configuration

Parameter	Required	Example	Description
url	yes	https://my-jenkins.com	the base url for a Jenkins deployment
job	yes		the job name in the Jenkins deployment at the given url
token	for put	see below (1)	the Authentication Token for the given job
username	unknown, but likely		a username that can be used to authorize with the given Jenkins url
login	unknown, but likely		either the password or an api token associated with the given username

Note: if login is set, then surely username must be set to a corresponding username for it to have any effect. It is unknown if a Jenkins deployment can be configured such that both username and login are not required

(1) the above can be found at $YOUR_JENKINS > $YOUR_JOB > Configure

Behavior

check

Produces new versions for all builds (after the last version) ordered by the build number

in

Parameter	Required	Example	Description
accept_results	no	[SUCCESS]	array of acceptable results of the build. The step will fail if none match. Empty arrays are ignored
regexp	no	[path/to/output.*]	limits downloaded artifacts to only those that match one of the given patterns. Hidden files (ex: .git) will be ignored
skip_download	no		whether or not to download any of the artifacts at all. Overrides regexp. Default false

Optionally gets the specified artifacts outputted by the most recent build

Metadata is made available at ./.metadata/name. ex:

$ cat ./my-jenkins-job/.metadata/result
SUCCESS

out

Parameter	Required	Example	Description
cause	no		the cause of the build being triggered. Default caused by $ATC_EXTERNAL_URL/builds/$BUILD_ID
cause_file	no	path/to/cause	path to a file containing the cause of the build being triggered
description	no		the description of the build. Default build triggered by $ATC_EXTERNAL_URL/builds/$BUILD_ID
description_file	no	path/to/description	path to a file containing the description of the build
build_params	no	any object	name-value pairs that will be passed to the build as build parameters

Triggers a new build of the target job and gets the result

developing

• make is recommended - version 3.81 is tested
• golang is required - version 1.18.x or above is required for generics
• docker is required - version 20.10.x is tested