From 28a4296f31812a24e55ac962181d73557128d8bc Mon Sep 17 00:00:00 2001 From: Mark Waite Date: Wed, 6 Nov 2024 10:53:57 -0700 Subject: [PATCH] Minor documentation update (#79) * Update README * Remove CHANGELOG since its contents are now in GitHub releases * https://github.com/jenkinsci/build-timestamp-plugin/releases/tag/build-timestamp-1.0.0 * https://github.com/jenkinsci/build-timestamp-plugin/releases/tag/build-timestamp-1.0.1 * https://github.com/jenkinsci/build-timestamp-plugin/releases/tag/build-timestamp-1.0.2 * https://github.com/jenkinsci/build-timestamp-plugin/releases/tag/build-timestamp-1.0.3 --- CHANGELOG.md | 21 --------------------- README.md | 21 +++++++++++---------- 2 files changed, 11 insertions(+), 31 deletions(-) delete mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index c18ac45..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,21 +0,0 @@ -# Changes - -## 1.0.3 - -- [PR \#3](https://github.com/jenkinsci/build-timestamp-plugin/pull/3) - -## 1.0.2 - -- Added Optional date/time shift - - For additional variables you can define shift (days, hours, minutes) - which will be added to build timestamp. This allows to run build - plan with previous day specified as parameter. - -## 1.0.1 - -- Fixed validation issue (combobox does not support validation) - -## 1.0.0 - -- Initial release. \ No newline at end of file diff --git a/README.md b/README.md index bde59ee..7bf23be 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,53 @@ # [LOOK FOR NEW MAINTAINER] -# build-timestamp-plugin -Adding `BUILD_TIMESTAMP` to jenkins env vars, +# Build Timestamp Plugin + +Adding `BUILD_TIMESTAMP` to Jenkins env vars, ## Daylight Saving Time + DST is not enabled by default. If your location uses DST, you can enable it by setting the `timezone` to the correct `city` such as `America/New_York`. Set the timezone to corresponding city, such as `America/New_York` to display Daylight Saving Time format when Daylight Saving Time is enabled. ## More vars and formats + Add more var names and formats if you need. ## Optional date/time shift + For additional variables you can define shift (days, hours, minutes) which will be added to build timestamp. This allows to run build plan with previous day specified as parameter. Export build timestamps to build env variables. # Configure + `BUILD_TIMESTAMP` exported by default, and you can add more variables with different format patterns in Global Configure page. ![](docs/images/global-config.png) - # Using timestamps in Maven/Gradle/Shell + They are available in Maven build and Gradle build as built-in properties/variables as well. Maven: As defined property in pom, equals to -``` syntaxhighlighter-pre +``` System.getProperty('BUILD_TIMESTAMP') ``` Gradle: -``` syntaxhighlighter-pre +``` System.getenv('BUILD_TIMESTAMP') ``` Shell: -``` syntaxhighlighter-pre +``` "$BUILD_TIMESTAMP" ``` - -# Open Issues -[View these issues in Jira](https://issues.jenkins.io/issues/?jql=resolution%20is%20EMPTY%20and%20component%3D21120) -