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

Add example global config to Readme and wiki pages

    • Icon: Improvement Improvement
    • Resolution: Unresolved
    • Icon: Minor Minor
    • timestamper-plugin
    • None

      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]

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

          Gabriel Schulze created issue -
          Gabriel Schulze made changes -
          Description Original: 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]]
          New: 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 Crow made changes -
          Assignee Original: Steven G Brown [ stevengbrown ]

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

              Created:
              Updated: