Skip to content

Update breaking changes #2351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 9, 2020
Merged

Update breaking changes #2351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
27714dd
Improve formatting
asbjornu Jul 9, 2020
63cd255
Add information about the deprecation of GitVersionConfig.yaml
asbjornu Jul 9, 2020
6425a50
Add information about breaking changes in v5.0.0
asbjornu Jul 9, 2020
1513702
Replace space with underscore in BREAKING_CHANGES.md
asbjornu Jul 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions BREAKING CHANGES.md
View file
Open in desktop

This file was deleted.

47 changes: 47 additions & 0 deletions BREAKING_CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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