Merge pull request #2351 from asbjornu/feature/update-breaking-changes

Update breaking changes

BREAKING_CHANGES.md

@@ -0,0 +1,47 @@
+## v5.0.0
+
+- Version numbers in branches other than `release` branches are no longer
+  considered as a version source by default. Implemented in [#1541][pr-1541].
+- [#1581][pr-1581] folds `GitTools.Core` back into GitVersion to make
+  maintaining GitVersion easier.
+
+## v4.0.0
+
+### Git Flow Changes
+
+When using GitFlow, a few things have changed. Hopefully the new settings just
+work for you
+
+- `develop` has pre-release tag of `alpha` now, not unstable.
+- `develop` will bump as soon as a `release` branch is created.
+- Look at the [GitFlow examples][gitflow] for details of how it works now.
+
+### Configuration Changes
+
+- `GitVersionConfig.yaml` is deprecated in favor of `GitVersion.yml`.
+- Regular expressions are no longer used as keys in branch config
+    - We have named branches, and introduced a `regex` config which you can
+      override.
+    - The default keys are: `master`, `develop`, `feature`, `release`, `pull-request`,
+      `hotfix` and `support`
+    - Just run `GitVersion.exe` in your project directory and it will tell you
+      what to change your config keys to
+    - For example, `dev(elop)?(ment)?$` is now just `develop`, we suggest not
+      overring regular expressions unless you really want to use a different convention.
+- `source-branches` added as a configuration option for branches, it helps
+  GitVersion pick the correct source branch
+
+## v3.0.0
+
+- NextVersion.txt has been deprecated, only `GitVersionConfig.yaml` is supported
+- `AssemblyFileSemVer` variable removed, `AssemblyVersioningScheme` configuration
+  value makes this variable obsolete
+- Variables `ClassicVersion` and `ClassicVersionWithTag` removed
+- MSBuild task arguments (`AssemblyVersioningScheme`, `DevelopBranchTag`,
+  `ReleaseBranchTag`, `TagPrefix`, `NextVersion`) have been removed, use
+  `GitVersionConfig.yaml` instead
+- GitVersionTask's `ReleaseDateAttribute` no longer exists
+
+[gitflow]: https://gitversion.net/docs/git-branching-strategies/gitflow-examples_complete
+[pr-1541]: https://github.com/GitTools/GitVersion/pull/1541
+[pr-1581]: https://github.com/GitTools/GitVersion/pull/1581