Contents
Hudson and Jenkins integration into Trac
Description
This plugin integrates Hudson or the actual fork Jenkins build results into the Trac timeline and (optionally) provides a navbar menu to link to the Hudson instance.
This plugin works very similar to the LuntbuildTracIntegration plugin. The build results are obtained from the Hudson remote API.
Note: as of version 0.4 this plugin requires Hudson 1.367 or later; if you are running an earlier version of Hudson, then you'll need to grab r7912 instead.
For additional integration between Trac and Jenkins see Jenkins Trac Plugin and Jenkins Trac Publisher Plugin.
Bugs/Feature Requests
Existing bugs and feature requests for HudsonTracPlugin are here.
If you have any issues, create a new ticket.
defect |
26 / 27 |
||
---|---|---|---|
enhancement |
10 / 14 |
||
task |
3 / 3 |
Download
Download the zipped source from here.
Source
Check out HudsonTracPlugin from here using Subversion, or browse the source with Trac.
Installation
General instructions on installing Trac plugins can be found on the TracPlugins page.
As with all plugins, you must enable it explicitly, either via Trac's Admin panel (Admin -> General -> Plugins) or by directly editing your trac.ini
file:
[components] hudsontrac.* = enabled
Configuration
There are the following options you can configure in your trac.ini
file under the section [hudson]
. If you have the IniAdminPlugin installed they will show up on the Trac Admin page under hudson
:
- job_url
-
The url of the top-level hudson page if you want to display all
jobs in the timeline, or a job or module url if you want only
display builds from a single job or module.
Examples:
http://localhost/hudson/
(for builds from all jobs),http://localhost/hudson/job/build_foo/
(for builds from thebuild_foo
job only). The default ishttp://localhost/hudson/
. - username
- The username to use when accessing hudson; leave empty if no authentication is needed. Default is empty.
- password
- The password to use when accessing hudson; leave empty if no authentication is needed. Default is empty.
- api_token
- The API Token to use to access Jenkins. This takes precedence over any password and is the preferred mechanism if you are running Jenkins 1.426 or later and Jenkins is enforcing authentication (as opposed to, for example, a proxy in front of Jenkins).
- display_modules
-
If set to
true
then display the builds of individual modules in the timeline too; otherwise only builds of jobs are displayed. Default isfalse
. - main_page
-
The url of the hudson page to link to from the trac mainnav; if
empty, no entry is created in the mainnav. Example:
/hudson/
. The default is/hudson/
. - timeline_opt_label
-
The label to use for the above link; defaults to
Hudson Builds
. - display_in_new_tab
-
If set to
true
then open the above hudson page in a new tab (or window) instead of in the current tab/window. Not used ifmain_page
is not set. Default isfalse
. - alternate_success_icon
-
Display a green ball instead of the standard blue one for
successful builds. Default is
false
. - display_build_descriptions
-
Whether to display the build descriptions for each build instead of
the canned "Build finished successfully" etc messages. Default is
true
. - display_building
-
If
true
, builds that have started but not yet completed will also be displayed in the timeline. - list_changesets
-
If set to
true
then each build entry in the timeline will also list all the changesets that triggered the build. - display_culprit
-
Display the culprit(s) for each build. This is a comma-separated
list of zero or more of the following tokens:
starter
,author
,authors
,culprit
,culprits
.starter
is the user that started the build, if any;author
is the author of the first commit, if any;authors
is the list of authors of all commits;culprit
is the first of what hudson thinks are the culprits that caused the build; andculprits
is the list of all culprits. If this option is a list, the first non-empty value is used. Example:starter,authors
(this would show who started the build if it was started manually, else list the authors of the commits that triggered the build if any, else show no author for the build).
Example trac.ini
:
[hudson] job_url = http://localhost/hudson/job/build_foo/ main_page = /hudson/job/build_foo/ alternate_success_icon = true
Note that it is not necessary to specify this hudson
section if you are using the default values.
Lastly, make sure you assign users the BUILD_VIEW
permission for them to be able to see the builds in the timeline.
Upgrade Notes
If you are upgrading from version 0.3 of this plugin (pre r9467) then make sure you're running Hudson 1.367 or later.
If you are upgrading from version 0.2 of this plugin (pre r6683) then you will need to make the following changes:
- The
feed_url
option has been replaced by thejob_url
option; the latter points to the top-level hudson page or to a job page, not an RSS feed anymore. - The
display_subprojects
has been renameddisplay_modules
. - You must assign users the
BUILD_VIEW
permission in order for them to see the builds. - The python-feedparser library is no longer required.
Recent Changes
Author/Contributors
Author: roadrunner
Maintainer: roadrunner
Contributors:
Attachments (3)
-
hudson_plugin_screenshot.png (26.0 KB) - added by 13 years ago.
Screenshot of timeline with a couple hudson builds, the "Hudson Builds" checkbox, and the "Builds" menu item
-
hudson_logo.png (5.3 KB) - added by 7 years ago.
Hudson logo
-
jenkins_logo.png (9.0 KB) - added by 7 years ago.
Jenkins logo
Download all attachments as: .zip