taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity
wtf/_site/content/posts/modules/jenkins.md
Chris Cummer 75b81f8a7f Update the Jenkins module documentation
2018-06-13 02:47:01 -07:00

1.2 KiB
Raw Blame History

title, date, draft
title date draft
Modules: Jenkins 2018-06-09T20:53:35-07:00 false

Added in v0.0.8.

Displays jenkins status of given builds in a project or view

<img src="/imgs/modules/jenkins.png" alt="jenkins screenshot", width="320" height="68" alt="jenkins screenshot" />

Source Code

wtf/jenkins/

Required ENV Variables

Key: WTF_JENKINS_API_KEY
Value: Your Jenkins API key.

Keyboard Commands

None.

Configuration

jenkins:
  enabled: true
  position:
    top: 2
    left: 3
    height: 2
    width: 3
  refreshInterval: 300
  url: "https://jenkins.domain.com/jenkins/view_url"
  user: "username"

Attributes

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

position
Defines where in the grid this module's widget will be displayed.

refreshInterval
How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.

user
Your Jenkins username.

url
The url to your Jenkins project or view.
Values: A valid URI.