Changes between Version 27 and Version 28 of HudsonTracPlugin

Timestamp:

Nov 3, 2023, 8:50:27 PM (6 months ago)

Author:

Dirk Stöcker

Comment:

Add new options, update page

HudsonTracPlugin

@@ -8 +8 @@
 [[Image(jenkins_logo.png, align=right)]]
 
-This plugin integrates [http://hudson-ci.org/ Hudson] or the actual fork [http://jenkins-ci.org/ Jenkins] build results into the Trac timeline and (optionally) provides a navbar menu to link to the Hudson instance.
+This plugin integrates [https://jenkins-ci.org/ Jenkins] (or the discontinued Hudson) build results into the Trac timeline and (optionally) provides a navbar menu to link to the Jenkins 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.
+This plugin works very similar to the LuntbuildTracIntegration plugin. The build results are obtained from the Jenkins remote API.
 
 For additional integration between Trac and Jenkins see [https://wiki.jenkins-ci.org/display/JENKINS/Trac+Plugin Jenkins Trac Plugin] and [https://wiki.jenkins-ci.org/display/JENKINS/Trac+Publisher+Plugin Jenkins Trac Publisher Plugin].
 
 [[Image(hudson_plugin_screenshot.png, border=2)]]
+
+NOTE: For compatibility reasons the Plugin is named HudsonTracPlugin and not JenkinsTracPlugin and the config section is hudson and not jenkins.
 
 == Bugs/Feature Requests
@@ -50 +50 @@
 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
+   The url of the top-level Jenkins 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 the
+   Examples: `http://localhost/jenkins/` (for builds from all jobs),
+   `http://localhost/jenkins/job/build_foo/` (for builds from the
    `build_foo` job only).
-   The default is `http://localhost/hudson/`.
+   The default is `http://localhost/jenkins/`.
+ api_path::
+   The path part of the API, either "api/python" or "api/json".
+   The default is `api/json`.
+ interfacename::
+   The interfacename (i.e. Jenkins) to use.
+   The default is `Jenkins`.
+ nav_label::
+   The label for the nav menu entry (default value will be translated).
+   The default is `Builds`.
  username::
-   The username to use when accessing hudson; leave empty if no
+   The username to use when accessing Jenkins; leave empty if no
    authentication is needed. Default is empty.
  password::
-   The password to use when accessing hudson; leave empty if no
+   The password to use when accessing Jenkins; leave empty if no
    authentication is needed. Default is empty.
  api_token::
@@ -73 +82 @@
    Default is `false`.
  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/`.
+   The url of the Jenkins page to link to from the trac mainnav; if
+   empty, no entry is created in the mainnav. Example: `/jenkins/`.
+   The default is `/jenkins/`.
  timeline_opt_label::
-   The label to use for the above link; defaults to `Hudson Builds`.
+   The label to use for the above link, can contain %(interfacename) to be replaced by the interface name option.
+   The default is `%(interfacename)s Builds`.
  display_in_new_tab::
-   If set to `true` then open the above hudson page in a new tab (or
+   If set to `true` then open the above Jenkins page in a new tab (or
    window) instead of in the current tab/window. Not used if
    `main_page` is not set. Default is `false`.
@@ -101 +111 @@
    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
+   `culprit` is the first of what Jenkins thinks are the culprits that
    caused the build; and `culprits` is the list of all culprits. If
    this option is a list, the first non-empty value is used. Example:
@@ -111 +121 @@
 {{{#!ini
 [hudson]
-job_url = http://localhost/hudson/job/build_foo/
-main_page = /hudson/job/build_foo/
+job_url = http://localhost/jenkins/job/build_foo/
+main_page = /jenkins/job/build_foo/
 alternate_success_icon = true
 }}}
@@ -119 +129 @@
 
 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 the `job_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 renamed `display_modules`.
- * You must assign users the `BUILD_VIEW` permission in order for them to see the builds.
- * The [http://www.feedparser.org/ python-feedparser] library is no longer required.
 
 == Recent Changes