Merge pull request #64 from nebula-plugins/better-shorten-defaults

Add better defaults for shortenedBranchPattern. Fixes #46.

Author: nadavc

README.md

@@ -48,7 +48,7 @@ All tasks default to bumping the minor version.
     nebulaRelease {
       Set<String> releaseBranchPatterns = [/master/, /HEAD/, /(release(-|\/))?\d+(\.\d+)?\.x/, /v?\d+\.\d+\.\d+/] as Set
       Set<String> excludeBranchPatterns = [] as Set
-      String shortenedBranchPattern = /(?:feature(?:-|\/))?(.+)/
+      String shortenedBranchPattern = /(?:(?:bugfix|feature|hotfix|release)(?:-|\/))?(.+)/
 
       void addReleaseBranchPattern(String pattern)
       void addExcludeBranchPattern(String pattern)
@@ -58,7 +58,7 @@ All tasks default to bumping the minor version.
 | ----------------------- | ------------- | ------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | releaseBranchPatterns   | `Set<String>` | `[/master/, /HEAD/, /(release(-|\/))?\d+(\.\d+)?\.x/, /v?\d+\.\d+\.\d+/]` | Branch patterns that are acceptable to release from. The default pattern will match things like `master`, `1.2.x`, `release-42.x`, `release/2.x`, `v1.2.3`. If the set is empty releases will be possible from any branch that doesn't match `excludeBranchPatterns`. |
 | excludeBranchPatterns   | `Set<String>` | `[]`                                                                      | Branch patterns that you cannot release from. If a branch matches both `releaseBranchPatterns` and `excludeBranchPatterns` it will be excluded.                                                                                                                       |
-| shortenedBranchPattern  | `String`      | `/(?:feature(?:-|\/))?(.+)/`                                              | Branch `widget1` will append `widget1` to snapshot version numbers, and branch `feature/widget2` will append `widget2` to snapshot version numbers. You may configure this field, the regex is expected to have exactly one capture group.                            |
+| shortenedBranchPattern  | `String`      | `/(?:(?:bugfix|feature|hotfix|release)(?:-|\/))?(.+)/`                    | Branch `widget1` will append `widget1` to snapshot version numbers, and branch `(feature|bugfix|release|hotfix)/widget2` will append `widget2` to snapshot version numbers. You may configure this field, the regex is expected to have exactly one capture group.    |
 
 
 | Method                  | Arguments        | Description                                                                                                                               |

src/main/groovy/nebula/plugin/release/ReleaseExtension.groovy

@@ -20,9 +20,11 @@ class ReleaseExtension {
     Set<String> excludeBranchPatterns = [] as Set
 
     /**
-     * This should be a regex pattern with one(1) capture group
+     * This should be a regex pattern with one(1) capture group. By default shortens the typical
+     * {bugfix|feature|hotfix|release}/branch-name to branch-name. The prefix is optional and a
+     * dash may be used instead of the forward slash.
      */
-    String shortenedBranchPattern = /(?:feature(?:-|\/))?(.+)/
+    String shortenedBranchPattern = /(?:(?:bugfix|feature|hotfix|release)(?:-|\/))?(.+)/
 
     void addReleaseBranchPattern(String pattern) {
         releaseBranchPatterns.add(pattern)