Skip to content

Commit

Permalink
1.2.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
aleksandr-m committed Dec 22, 2015
1 parent c7fa260 commit c4a7f70
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 2 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## v1.2.1

* Added `commitMessages` configuration which allows to customize commit messages (see [#8](https://github.com/aleksandr-m/gitflow-maven-plugin/issues/8))
* Added maven site

## v1.2.0

* Added `release` goal for creating releases w/o separate release branch
Expand Down
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The plugin is available from Maven central.
<plugin>
<groupId>com.amashchenko.maven.plugin</groupId>
<artifactId>gitflow-maven-plugin</artifactId>
<version>1.2.0</version>
<version>1.2.1</version>
<configuration>
<!-- optional configuration -->
</configuration>
Expand Down Expand Up @@ -77,8 +77,37 @@ Since `1.0.7` version of this plugin the output of the executed commands will NO
<supportBranchPrefix>support/</supportBranchPrefix>
<versionTagPrefix></versionTagPrefix>
</gitFlowConfig>

<commitMessages>
<!-- since 1.2.1, see Customizing commit messages -->
</commitMessages>
</configuration>

## Customizing commit messages

Since `1.2.1` commit messages can be changed in plugin's configuration section in pom.xml. Commit messages defaults are seen below.

<configuration>
<commitMessages>
<featureStartMessage>updating versions for feature branch</featureStartMessage>
<featureFinishMessage>updating versions for development branch</featureFinishMessage>
<hotfixStartMessage>updating versions for hotfix</hotfixStartMessage>
<hotfixFinishMessage>updating for next development version</hotfixFinishMessage>
<releaseStartMessage>updating versions for release</releaseStartMessage>
<releaseFinishMessage>updating for next development version</releaseFinishMessage>
<tagHotfixMessage>tagging hotfix</tagHotfixMessage>
<tagReleaseMessage>tagging release</tagReleaseMessage>
</commitMessages>
</configuration>

Maven properties can be used in commit messages. For example `<featureStartMessage>updating ${artifactId} project for feature branch</featureStartMessage>` will produce message where
`${artifactId}` will be substituted for projects `<artifactId>`.

Note that although `${project.version}` can be used any changes to version introduced by this goal won't be reflected in a commit message for this goal.

## Additional goal parameters

The `gitflow:release-finish`, `gitflow:release` and `gitflow:hotfix-finish` goals have `skipTag` parameter. This parameter controls whether the release/hotfix will be tagged in Git.
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<artifactId>gitflow-maven-plugin</artifactId>
<packaging>maven-plugin</packaging>
<name>gitflow-maven-plugin</name>
<version>1.2.1-SNAPSHOT</version>
<version>1.2.1</version>

<description>Git-Flow Maven Plugin, which runs Git and Maven commands from the command line. Supports Eclipse Plugins build with Tycho.</description>

Expand Down
2 changes: 2 additions & 0 deletions src/site/markdown/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

This plugin runs Git and Maven commands from the command line ensuring that all Git features work properly.

Supports Eclipse Plugin projects build with [Tycho](https://eclipse.org/tycho/).

# Usage

If you feel like the plugin is missing a feature or has a defect, create a [new issue](https://github.com/aleksandr-m/gitflow-maven-plugin/issues/new) or submit a [Pull Request](https://github.com/aleksandr-m/gitflow-maven-plugin/pulls).
Expand Down

0 comments on commit c4a7f70

Please sign in to comment.