Skip to content

Commit

Permalink
Merge pull request #20 from Dohbedoh/infra/doctogithub
Browse files Browse the repository at this point in the history
[INFRA] Review documentation and move to GitHub
  • Loading branch information
Dohbedoh authored Oct 20, 2020
2 parents 5a06e93 + c125632 commit 52d9f7b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 14 deletions.
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,34 @@
[![][ButlerImage]][website]
[![][ButlerImage]][Jenkins]

SemanticVersioning (for Jenkins)
==========

[![Jenkins](https://ci.jenkins.io/job/Plugins/job/semantic-versioning-plugin/job/master/badge/icon)](https://ci.jenkins.io/job/Plugins/job/semantic-versioning-plugin/job/master/)
[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/semantic-versioning-plugin.svg)](https://plugins.jenkins.io/semantic-versioning-plugin)
[![Jenkins Plugin Contributors](https://img.shields.io/github/contributors/jenkinsci/semantic-versioning-plugin.svg?color=blue)](https://github.com/jenkinsci/semantic-versioning-plugin/graphs/contributors)
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/semantic-versioning-plugin.svg?color=blue&label=installations)](https://github.com/jenkinsci/semantic-versioning-plugin/graphs/contributors)
[![Jenkins Plugin Release](https://img.shields.io/github/release/jenkinsci/semantic-versioning-plugin.svg?label=changelog)](https://github.com/jenkinsci/semantic-versioning-plugin/releases/latest)


About
-----
The SemanticVersioning plugin for [Jenkins]([website]) is a plugin that reads the base version (Major, Minor, SNAPSHOT) settings from various build definition file formats. The plugin currently supports POM and SBT (Build.scala). SemanticVersioning uses the values parsed from the build definition files in conjunction with the [Jenkins]([website]) build number to create a [Semantic Versioning]([semver]) string. The string is stored in an build-environment variable (name is configurable). Additionally the [Semantic Versioning]([semver]) string is written to a file in the Artifact directory.
The SemanticVersioning plugin for [Jenkins] is a plugin that reads the base version (Major, Minor, SNAPSHOT) settings
from various build definition file formats. The plugin currently supports POM and SBT (Build.scala).

SemanticVersioning uses the values parsed from the build definition files in conjunction with the
[Jenkins] build number to create a [Semantic Versioning] string.

The second part of the plugin adds a column to the Dashboard that displays the [Semantic Versioning]([semver]) string from the most recent successful build.
The string is stored in an build-environment variable (name is configurable). Additionally the
[Semantic Versioning] string is written to a file in the Artifact directory.

Source
------
The latest and greatest source for the SemanticVersioning plugin can be found on [GitHub]. Fork us!
The second part of the plugin adds a column to the Dashboard that displays the [Semantic Versioning] string from the
most recent successful build.

Pull / Feature Requests
-----
Both are welcome and will be prioritized and executed as time and resource allows.

Current Build Status
-----
[![Build Status](https://jenkins.ci.cloudbees.com/buildStatus/icon?job=plugins/semantic-versioning-plugin)](https://jenkins.ci.cloudbees.com/job/plugins/job/semantic-versioning-plugin/)

[ButlerImage]: http://jenkins-ci.org/sites/default/files/jenkins_logo.png
[MIT License]: https://github.com/jenkinsci/jenkins/raw/master/LICENSE.txt
[GitHub]: https://github.com/ciroque/SemanticVersioning
[website]: http://jenkins-ci.org
[semver]: http://semver.org/
[Jenkins]:https://www.jenkins.io/
[Semantic Versioning]:http://semver.org/
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<version>1.13-SNAPSHOT</version>
<packaging>hpi</packaging>
<name>Semantic Versioning Plugin</name>
<url>http://wiki.jenkins-ci.org/display/JENKINS/semantic-versioning-plugin</url>
<url>https://github.com/jenkinsci/semantic-versioning-plugin</url>
<build>
<plugins>
<plugin>
Expand Down

0 comments on commit 52d9f7b

Please sign in to comment.