Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-60889

Add example global config to Readme and wiki pages

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      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 looks like the example below, should be easily accessible.

      <?xml version='1.0' encoding='UTF-8'?>
      <hudson.plugins.timestamper.TimestamperConfig plugin="timestamper@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]

        Attachments

          Activity

          gaschu Gabriel Schulze created issue -
          gaschu Gabriel Schulze made changes -
          Field Original Value New Value
          Description 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="timestamper@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]]
          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 looks like the example below, should be easily accessible.

          {{<?xml version='1.0' encoding='UTF-8'?>}}
           {{<hudson.plugins.timestamper.TimestamperConfig plugin="timestamper@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]]
          basil Basil Crow made changes -
          Assignee Steven G Brown [ stevengbrown ]
          Hide
          mwinter69 Markus Winter added a comment -

          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

           

          Show
          mwinter69 Markus Winter added a comment - 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  

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            gaschu Gabriel Schulze
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated: