Skip to content

Commit d853e7b

Browse files
committed
Making it clear in the readme that GitVersion ships with default internal configuration and you don't have to configure it to make it work
1 parent 3f19a66 commit d853e7b

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,18 +108,24 @@ For the `release/3.0.0` branch of GitVersion it shows:
108108
```
109109

110110
## Configuration
111-
GitVersion 3.0 is mainly powered by configuration and no longer has branching strategies hard coded. This means it probably can be changed to work for your scenario.
111+
GitVersion 3.0 is mainly powered by configuration and no longer has branching strategies hard coded.
112+
**Note: ** GitVersion ships with internal default configuration which works with GitHubFlow and GitFlow, probably with others too. You **do not** need to run `GitVersion /init` to get started!
113+
114+
You can run `GitVersion /showConfig` to see the effective configuration (defaults + overrides)
112115

113116
To create your config file just type `GitVersion init` in your repo directory after installing via chocolatey and we will create a sample (but commented out) config file.
114117
Uncomment and modify as you need.
115118

116119
The configuration options are:
117120

121+
- `next-version`: Allows you to bump the next version explicitly, useful for bumping `master` or a feature with breaking changes a major increment.
118122
- `assembly-versioning-scheme`: When updating assembly info tells GitVersion how to treat the AssemblyVersion attribute. Useful to lock the major when using Strong Naming.
119123
- `mode`: Either ContinuousDelivery or ContinuousDeployment. See [Octopus Deploy/CI Build NuGet Packages](#continuousdeployment) above for more information
120124
- `continuous-delivery-fallback-tag`: When using `mode: ContinuousDeployment` the value specified will be used as the pre-release tag for branches which do not have one specified.
121125
- `tag-prefix`: A regex which is used to trim git tags before processing (eg v1.0.0). Default is `[vV]` though this is just for illustrative purposes as we do a IgnoreCase match and could be `v`
122126

127+
#### Branch configuration
128+
123129
Then we have branch specific configuration, which looks something like this:
124130

125131
``` yaml

0 commit comments

Comments
 (0)