These examples are illustrating the usage of the supported
GitHubFlow workflow in GitVersion. To enable this
workflow, the builtin template
GitHubFlow/v1 needs
to be referenced in the configuration as follows:
workflow: GitHubFlow/v1
mode: ContinuousDelivery
Where the
continuous deployment
mode for no branches, the
continuous delivery
mode for main branch and the
manual deployment
mode for release, feature and
unknown branches are specified.
This configuration allows you to publish CI (Continuous Integration)
builds from main branch to an artifact repository. All
other branches are manually published. Read more about this at
version increments.
The continuous delivery mode has been used for the
main branch in this examples (specified as a fallback
on the root configuration layer) to illustrate how the version
increments are applied. In production context the
continuous deployment mode might be a better option when
e.g. the release process is automated or the commits are tagged by
the pipeline automatically.
Feature Branch
Feature branches can be used in the GitHubFlow workflow
to implement a feature or fix a bug in an isolated environment.
Feature branches will take the feature branch name and use that as
the pre-release label. Feature branches will be created from a
main or release branch.
Create feature branch from main
After the feature branch is merged, the version on
main is 2.0.0-5. This is due to
main running in continuous delivery mode. If
main was configured to use
continuous deployment the version would be
2.0.0.
Release Branches
Release branches are used for major, minor and patch releases to
stabilize a RC (Release Candidate) or to integrate features/hotfixes
(in parallel) targeting different iterations. Release branches are
taken from main and will be merged back afterwards.
Finally the main branch is tagged with the released
version.
Release branches can be used in the GitHubFlow as well
as GitFlow workflow. Sometimes you want to start on a
large feature which may take a while to stabilize so you want to
keep it off main. In these scenarios you can either create a long
lived feature branch (if you do not know the version number this
large feature will go into, and it's non-breaking) otherwise you can
create a release branch for the next major version. You can then
submit pull requests to the long lived feature branch or the release
branch.
Create release branch
Create release branch with version
To Contribute
Source
See DocumentationSamplesForGitHubFlow.cs. To update,
modify then run test.