mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Added jenkins module documentation
This commit is contained in:
parent
eb547136cf
commit
e73037c84c
52
_site/content/posts/modules/jenkins.md
Normal file
52
_site/content/posts/modules/jenkins.md
Normal file
@ -0,0 +1,52 @@
|
||||
---
|
||||
title: "Modules: Jenkins"
|
||||
date: 2018-06-09T20:53:35-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
Displays jenkins status of given builds in a project or view
|
||||
|
||||
<img src="/imgs/modules/jenkins.png" alt="jenkins screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/jenkins/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
<span class="caption">Key:</span> `WTF_JENKINS_API_KEY` <br />
|
||||
<span class="caption">Value:</span> Your <a href="https://wiki.jenkins.io/display/JENKINS/Remote+access+API">Jenkins API</a> key.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
jenkins:
|
||||
user: "username"
|
||||
url: "https://jenkins.domain.com/jenkins/view_url"
|
||||
enabled: true
|
||||
position:
|
||||
top: 2
|
||||
left: 3
|
||||
height: 2
|
||||
width: 3
|
||||
refreshInterval: 300
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`user` <br />
|
||||
Your Jenkins username. <br />
|
||||
|
||||
`url` <br />
|
||||
The url to your Jenkins project or view. <br />
|
||||
Values: A valid URI.
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
BIN
_site/static/imgs/modules/jenkins.png
Normal file
BIN
_site/static/imgs/modules/jenkins.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 13 KiB |
Loading…
x
Reference in New Issue
Block a user