====== Jenkins Plugin ======

---- plugin ----
description: Display your jenkins jobs inside DokuWiki
author     : Algorythm 
email      : ttamalfor@gmail.com 
type       : syntax
lastupdate : 2017-08-09
compatible : Frusterick Manners, Elenor of Tsort, Detritus, Hrun
depends    : 
conflicts  : 
similar    : 
tags       : jenkins

downloadurl: https://github.com/algorys/dokuwiki-jenkins/archive/master.zip
bugtracker : https://github.com/algorys/dokuwiki-jenkins/issues
sourcerepo : https://github.com/algorys/dokuwiki-jenkins
donationurl: 

screenshot_img : # https://s1.postimg.org/olp2xm0f3/jenkins_preview.png
----

DokuWiki-Jenkins allow you display Job status of a Jenkins server.

Features:
  * Display last build of a Job or a specific build
  * Display status of build
  * Display "weather" of the Job
  * Follow new Blue Ocean theme

In future versions, it will allow you to trigger a job from DokuWiki if possible...


===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.


===== Requirements =====

No requirements needed.


===== Syntax =====

Simply use the following syntax:

<code php>
<jenkins job="JOB_NAME" />
</code>

If your job is in a folder, please use it as follow:

<code php>
<jenkins job="FOLDER/JOB_NAME" />
</code>

By default, jenkins plugin display the last build of your job. If you want to display a specific build, you can by adding the ''build'' option:

<code php>
<jenkins job="FOLDER/JOB_NAME" build="459"/>
</code>


===== Preview =====

%%{{https://s1.postimg.org/olp2xm0f3/jenkins_preview.png}}%% FIXME


===== Configuration and Settings =====

You should configure DokuWiki-Jenkins in the Config Manager of DokuWiki:

  * **jenkins.url**: Put your Jenkins url here, without a slash ending. i.e.: <nowiki>"http://my-jenkins.com"</nowiki>.
  * **jenkins.user**: Enter the ID of a Jenkins user, with the right to view any job..
  * **jenkins.token**: Set the corresponding Jenkins user token. You can find it in <nowiki>"http://JENKINS_URL/user/USER/configure"</nowiki>, then click on ''Show API Token'' button.


===== Change Log =====

{{rss>https://github.com/algorys/dokuwiki-jenkins/commits/master.atom 5 author date}}


===== Known Bugs and Issues =====

Please report your issues or your ideas at an [[https://github.com/algorys/dokuwiki-jenkins/issues|issue tracker]].