Skip to content

Jenkins

Displays Jenkins status of given builds in a project or view.

Configuration

jenkins:
  apiKey: "p0d13*********************************************c3"
  enabled: true
  position:
    top: 2
    left: 3
    height: 2
    width: 3
  refreshInterval: 300
  successBallColor: "green"
  jobNameRegex: ^[a-z]+\[[0-9]+\]$
  url: "https://jenkins.domain.com/jenkins/view_url"
  user: "username"
  verifyServerCertificate: true

Screenshots

jenkins screenshot

Attributes

Name Value
apiKey
Your Jenkins API key. Leave this blank to use the WTF_JENKINS_API_KEY environment variable.
jobNameRegex
Optional A regex that filters the jobs shown in the widget. Any jobs matching the regular expression will be shown.
A valid regex, e.g. ^[a-z]+\[[0-9]+\]$
successBallColor
Changes the default color of successful Jenkins jobs to the color of your choosing.
Any valid color name, blue, green, purple, yellow, etc.
url
The URL to your Jenkins project or view.
A valid URI.
username
Your Jenkins username.
verifyServerCertificate
Whether or not to verify the server's certificate chain and hostname. Default: false.
true, false

Keyboard

Key Action
/ Open/close the widget's help modal
[return] Open the selected job in the browser
j Select the next item in the list
k Select the previous item in the list
r Refresh the data
Select the next item in the list
Select the previous item in the list

Source Code

https://github.com/wtfutil/wtf/tree/master/modules/jenkins