Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[INFRA] Review documentation and move to GitHub #20

Merged
merged 1 commit into from
Oct 20, 2020
Merged

[INFRA] Review documentation and move to GitHub #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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