Skip to content

Commit 37c4aaa

Browse files
Resolve PR review comments
1 parent c279bb8 commit 37c4aaa

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

docs/input/docs/reference/configuration.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ found that is generally what is needed when using GitFlow.
3131
To see the effective configuration (defaults and overrides), you can run
3232
`gitversion /showConfig`.
3333

34-
To create your config file just type `gitversion init` in your repo directory
35-
after installing via Chocolatey and a minimal `GitVersion.yml` configuration
36-
file will be created. Modify this to suit your needs.
34+
To create your config file just type `gitversion init` in your repo directory,
35+
after [installing]. A minimal `GitVersion.yml` configuration file will be
36+
created. Modify this to suit your needs.
3737

3838
## Global configuration
3939

@@ -271,9 +271,9 @@ merge-message-formats:
271271

272272
The regular expression should contain the following capture groups:
273273

274-
+ SourceBranch - Identifies the source branch of the merge
275-
+ TargetBranch - Identifies the target of the merge
276-
+ PullRequestNumber - Captures the pull-request number
274+
* `SourceBranch` - Identifies the source branch of the merge
275+
* `TargetBranch` - Identifies the target branch of the merge
276+
* `PullRequestNumber` - Captures the pull-request number
277277

278278
Custom merge message formats are evaluated _before_ any built in formats.
279279

@@ -412,16 +412,16 @@ Take this commit graph
412412

413413
By looking at this graph, you cannot tell which of these scenarios happened:
414414

415-
+ feature/foo branches off release/v1.0.0
416-
+ Branch release/v1.0.0 from main
417-
+ Branch feature/foo from release/v1.0.0
418-
+ Add a commit to both release/v1.0.0 and feature/foo
419-
+ release/v1.0.0 is the base for feature/foo
420-
+ release/v1.0.0 branches off feature/foo
421-
+ Branch feature/foo from main
422-
+ Branch release/v1.0.0 from feature/foo
423-
+ Add a commit to both release/v1.0.0 and feature/foo
424-
+ feature/foo is the base for release/v1.0.0
415+
* feature/foo branches off release/v1.0.0
416+
* Branch release/v1.0.0 from main
417+
* Branch feature/foo from release/v1.0.0
418+
* Add a commit to both release/v1.0.0 and feature/foo
419+
* release/v1.0.0 is the base for feature/foo
420+
* release/v1.0.0 branches off feature/foo
421+
* Branch feature/foo from main
422+
* Branch release/v1.0.0 from feature/foo
423+
* Add a commit to both release/v1.0.0 and feature/foo
424+
* feature/foo is the base for release/v1.0.0
425425

426426
Or put more simply, you cannot tell which branch was created first,
427427
`release/v1.0.0` or `feature/foo`.
@@ -544,7 +544,7 @@ Indicates this branch config represents a release branch in GitFlow.
544544
### is-mainline
545545

546546
When using Mainline mode, this indicates that this branch is a mainline. By
547-
default *main* and *support* are mainlines.
547+
default `main` and `support/*` are mainlines.
548548

549549
### pre-release-weight
550550

@@ -563,6 +563,7 @@ and [1366].
563563
[1145]: https://github.com/GitTools/GitVersion/issues/1145
564564
[1366]: https://github.com/GitTools/GitVersion/issues/1366
565565
[2506]: https://github.com/GitTools/GitVersion/pull/2506#issuecomment-754754037
566+
[installing]: /docs/usage/cli/installation
566567
[modes]: /docs/reference/modes
567568
[variables]: /docs/reference/variables
568569
[version-sources]: /docs/reference/version-sources

0 commit comments

Comments
 (0)