Merge pull request #768 from gusztavvargadr/feature/document-branch-name-variable-in-tag-configuration

Document branch name variable usage in tag configuration #664

Author: JakeGinnivan

docs/configuration.md

@@ -65,8 +65,9 @@ The options in here are:
 
  - **`mode:`** Same as above
 
- - **`tag:`** The pre release tag to use for this branch. Use the value `use-branch-name-as-tag` to use the branch name instead.  
-   For example `feature/foo` would become a pre-release tag of `foo` with this value  
+ - **`tag:`** The pre release tag to use for this branch.  
+   Use the value `useBranchName` to use the branch name instead. For example `feature/foo` would become a pre-release tag of `foo` with this value.  
+   Use the value `{BranchName}` as a placeholder to insert the branch name. For example `feature/foo` would become a pre-release tag of `alpha.foo` with the value of `alpha.{BranchName}`.  
    **Note:** To clear a default use an empty string: `tag: ""`
 
  - **`increment:`** the part of the SemVer to increment when GitVersion detects it needs to be (i.e commit after a tag)

docs/more-info/how-it-works.md

@@ -34,5 +34,5 @@ Each strategy needs to return an instance of `BaseVersion` which has the followi
  - `ShouldIncrement` - Some strategies should have the version incremented, others do not. eg `ConfigNextVersionBaseVersionStrategy` returns false, `HighestTagBaseVersionStrategy` returns true
  - `SemanticVersion` - SemVer of the base version strategy
  - `BaseVersionSource` - Sha of the source. Commits will be counted from this Sha. Can be null (eg ConfigNextVersionBaseVersionStrategy returns null)
- - `BranchNameOverride` - When `useBranchNameAsTag` is used, this allows the branch name to be changed by a base version.  
+ - `BranchNameOverride` - When `useBranchName` or `{BranchName}` is used in the tag configuration, this allows the branch name to be changed by a base version.  
    VersionInBranchBaseVersionStrategy uses this to strip out anything before the first - or /. So `foo` ends up being evaluated as `foo`. If in doubt, just use null