Skip to content

Commit dadb5ea

Browse files
author
Simon Ejsing
committed
update documentation to reflect the new implementation
1 parent 41ed659 commit dadb5ea

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

docs/configuration.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,10 @@ The options in here are:
7979
- **`prevent-increment-of-merged-branch-version:`** When `release-2.0.0` is merged into master, we want master to build `2.0.0`.
8080
If `release-2.0.0` is merged into develop we want it to build `2.1.0`, this option prevents incrementing after a versioned branch is merged
8181

82-
- **`tag-number-pattern:`** Pull requests require us to pull the pre-release number out of the branch name so `refs/pulls/534/merge` builds as `PullRequest.534`.
83-
This is a regex with a named capture group called `number`
84-
85-
- **`tag-name-pattern:`** This is similar to `tag-number-pattern` but instead of using the pull request number as the number part of the prerelease tag, the number is instead appended to the tag.
86-
This is only applicable when the branch mode is set to ContinuousDeployment, where the prerelease tag number part is based on the number of commits since the last tag.
87-
It enables consecutive commits to the pull request branch to generate unique full semantic version numbers when the branch is configured to use ContinuousDeployment mode and this value is set.
88-
This is a regex with a named capture group called `number`.
82+
- **`tag-number-pattern:`** Pull requests require us to extract the pre-release number out of the branch name so `refs/pulls/534/merge` builds as `PullRequest.534`.
83+
This is a regex with a named capture group called `number`
84+
If the branch mode is set to ContinuousDeployment, then the extracted `number` is appended to the name of the pre-release tag and the number portion is the number of commits since the last tag.
85+
This enables consecutive commits to the pull request branch to generate unique full semantic version numbers when the branch is configured to use ContinuousDeployment mode.
8986
Example usage:
9087
```yaml
9188
branches:

0 commit comments

Comments
 (0)