diff --git a/_site/content/posts/modules/jenkins.md b/_site/content/posts/modules/jenkins.md new file mode 100644 index 00000000..c4873621 --- /dev/null +++ b/_site/content/posts/modules/jenkins.md @@ -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 + +jenkins screenshot + +## Source Code + +```bash +wtf/jenkins/ +``` + +## Required ENV Variables + +Key: `WTF_JENKINS_API_KEY`
+Value: Your Jenkins API 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`
+Your Jenkins username.
+ +`url`
+The url to your Jenkins project or view.
+Values: A valid URI. + +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. diff --git a/_site/static/imgs/modules/jenkins.png b/_site/static/imgs/modules/jenkins.png new file mode 100644 index 00000000..4cd3521f Binary files /dev/null and b/_site/static/imgs/modules/jenkins.png differ