Skip to content

Commit 27714dd

Browse files
committed
Improve formatting
1 parent f1869c0 commit 27714dd

File tree

1 file changed

+37
-18
lines changed

1 file changed

+37
-18
lines changed

BREAKING CHANGES.md

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,37 @@
1-
v4.0.0
2-
- When using GitFlow, a few things have changed. Hopefully the new settings just work for you
3-
- develop has pre-release tag of `alpha` now, not unstable
4-
- develop will bump as soon as a release branch is created
5-
- Look at the [GitFlow examples](http://gitversion.readthedocs.io/en/latest/git-branching-strategies/gitflow-examples/) for details of how it works now
6-
- Regex's are no longer used as keys in branch config
7-
- We have named branches, and introduced a `regex` config which you can override.
8-
- The default keys are: master, develop, feature, release, pull-request, hotfix, support
9-
- Just run GitVersion.exe in your project directory and it will tell you what to change your config keys to
10-
- For example, `dev(elop)?(ment)?$` is now just `develop`, we suggest not overring regex's unless you really want to use a different convention.
11-
- source-branches added as a configuration option for branches, it helps GitVersion pick the correct source branch
12-
13-
v3.0.0
14-
- NextVersion.txt has been deprecated, only GitVersionConfig.yaml is supported
15-
- `AssemblyFileSemVer` variable removed, AssemblyVersioningScheme configuration value makes this variable obsolete
16-
- Variables `ClassicVersion` and `ClassicVersionWithTag` removed
17-
- MSBuild task arguments (AssemblyVersioningScheme, DevelopBranchTag, ReleaseBranchTag, TagPrefix, NextVersion) have been removed, use GitVersionConfig.yaml instead
18-
- GitVersionTask ReleaseDateAttribute no longer exists
1+
## v4.0.0
2+
3+
### Git Flow Changes
4+
5+
When using GitFlow, a few things have changed. Hopefully the new settings just
6+
work for you
7+
8+
- `develop` has pre-release tag of `alpha` now, not unstable.
9+
- `develop` will bump as soon as a `release` branch is created.
10+
- Look at the [GitFlow examples][gitflow] for details of how it works now.
11+
12+
### Configuration Changes
13+
14+
- Regular expressions are no longer used as keys in branch config
15+
- We have named branches, and introduced a `regex` config which you can
16+
override.
17+
- The default keys are: `master`, `develop`, `feature`, `release`, `pull-request`,
18+
`hotfix` and `support`
19+
- Just run `GitVersion.exe` in your project directory and it will tell you
20+
what to change your config keys to
21+
- For example, `dev(elop)?(ment)?$` is now just `develop`, we suggest not
22+
overring regular expressions unless you really want to use a different convention.
23+
- `source-branches` added as a configuration option for branches, it helps
24+
GitVersion pick the correct source branch
25+
26+
## v3.0.0
27+
28+
- NextVersion.txt has been deprecated, only `GitVersionConfig.yaml` is supported
29+
- `AssemblyFileSemVer` variable removed, `AssemblyVersioningScheme` configuration
30+
value makes this variable obsolete
31+
- Variables `ClassicVersion` and `ClassicVersionWithTag` removed
32+
- MSBuild task arguments (`AssemblyVersioningScheme`, `DevelopBranchTag`,
33+
`ReleaseBranchTag`, `TagPrefix`, `NextVersion`) have been removed, use
34+
`GitVersionConfig.yaml` instead
35+
- GitVersionTask's `ReleaseDateAttribute` no longer exists
36+
37+
[gitflow]: https://gitversion.net/docs/git-branching-strategies/gitflow-examples_complete

0 commit comments

Comments
 (0)