[JIRA] (JENKINS-60889) Add example global config to Readme and wiki pages

8 views
Skip to first unread message

gaschu95@gmail.com (JIRA)

unread,
Jan 28, 2020, 5:38:03 AM1/28/20
to jenkinsc...@googlegroups.com
Gabriel Schulze created an issue
 
Jenkins / Improvement JENKINS-60889
Add example global config to Readme and wiki pages
Issue Type: Improvement Improvement
Assignee: Steven G Brown
Components: timestamper-plugin
Created: 2020-01-28 10:37
Priority: Minor Minor
Reporter: Gabriel Schulze

It's very hard to find how to configure Timestamper though a configuration file. Just like in previous versions of the plugin it is explained how to enable the timestamps (e.g. with a timestamps {} block) there should be an example of how to set the global configuration.

Information such as, it needs to be an xml which roughly should looks like below should be easily accessible.

<?xml version='1.0' encoding='UTF-8'?>
<hudson.plugins.timestamper.TimestamperConfig plugin="times...@1.10">
    <timestampFormat>'<b>'HH:mm:ss'</b> '</timestampFormat>
    <elapsedTimeFormat>'<b>'HH:mm:ss.S'</b> '</elapsedTimeFormat>
    <allPipelines>true</allPipelines>
</hudson.plugins.timestamper.TimestamperConfig>

Please add this info to the Readme and to the wiki ([here|https://github.com/jenkinsci/timestamper-plugin] and [here|https://plugins.jenkins.io/timestamper] and [here|https://wiki.jenkins.io/display/JENKINS/Timestamper]

Add Comment Add Comment
 
This message was sent by Atlassian Jira (v7.13.6#713006-sha1:cc4451f)
Atlassian logo

gaschu95@gmail.com (JIRA)

unread,
Jan 28, 2020, 5:39:04 AM1/28/20
to jenkinsc...@googlegroups.com
Gabriel Schulze updated an issue
Change By: Gabriel Schulze
It's very hard to find how to configure Timestamper though a configuration file. Just like in previous versions of the plugin it is explained how to enable the timestamps (e.g. with a timestamps {} block) there should be an example of how to set the global configuration.

Information such as, it needs to be an xml which roughly should looks like the example below , should be easily accessible.


{{<?xml version='1.0' encoding='UTF-8'?>}}
{{<hudson.plugins.timestamper.TimestamperConfig plugin="times...@1.10">}}
{{    <timestampFormat> &apos;&lt; '< b &gt;&apos; >' HH:mm:ss &apos;&lt; '< /b &gt; &apos; > ' </timestampFormat>}}
{{    <elapsedTimeFormat>
&apos;&lt; '< b &gt;&apos; >' HH:mm:ss.S &apos;&lt; '< /b &gt; &apos; > ' </elapsedTimeFormat>}}

{{    <allPipelines>true</allPipelines>}}
{{</hudson.plugins.timestamper.TimestamperConfig>}}

Please add this info to the Readme and to the wiki ([here|[https://github.com/jenkinsci/timestamper-plugin]] and [here|[https://plugins.jenkins.io/timestamper]] and [here|[https://wiki.jenkins.io/display/JENKINS/Timestamper]]

me@basilcrow.com (JIRA)

unread,
Feb 26, 2020, 2:08:05 PM2/26/20
to jenkinsc...@googlegroups.com
Basil Crow assigned an issue to Unassigned
Change By: Basil Crow
Assignee: Steven G Brown
This message was sent by Atlassian Jira (v7.13.12#713012-sha1:6e07c38)
Atlassian logo

m_winter@gmx.de (JIRA)

unread,
Apr 13, 2020, 3:02:02 PM4/13/20
to jenkinsc...@googlegroups.com
Markus Winter commented on Improvement JENKINS-60889
 
Re: Add example global config to Readme and wiki pages

Three arguments why I don't like this:

  • I think the preferred way to configure a Jenkins instance is by using the configuration as code plugin nowadays.
  • It isn't hard to configure your Jenkins in the UI and then look up the generated XML in JENKINS_HOME that is not specific to this plugin but can be used for any plugin
  • It is another place you have to keep in sync in the docs which you will probably easy forget to update

 

Reply all
Reply to author
Forward
0 new messages