vtk-m/docs/ReleaseHotFix.md
Vicente Adolfo Bolea Sanchez 81076385f7 DOCS: add GitLab issue template new-release.md
It updates the ReleaseProcess.md document to describe our bi-branchial
workflow composed by a release branch and master branch

It also adds ReleaseHotFix.md which describes how to perform a HotFix
onto master/release branch.

Signed-off-by: Vicente Adolfo Bolea Sanchez <vicente.bolea@kitware.com>
2021-06-18 19:59:01 -04:00

1.6 KiB

Release HotFix

HotFix from master branch

On a single MR

You have created a branch from master branch and you have a MR request targeting the master branch.

You can bring this commit to release by adding to any empty line of the MR description box the following directive.

Backport: release

This will cherry-pick this commit and push it to release after typing Do: merge in a comment.

You must also make sure that there will not be any merge conflict with the release branch, thus you need to create an additional commit using the following command:

git merge --no-ff origin/release

This will ensure that backport will be able to push your commit to release.

On multiple MRs

  1. Create one merge request sourcing your HotFix branch and targeting master and merge.

  2. Create one merge request sourcing master and targeting release and merge.

HotFix from release branch

You have created a branch from the release branch and you have a MR request targeting release, you can proceed as in a regular MR.

Every merge in release will be automatically brought to master by the robot using -s ours strategy.

VERY IMPORTANT: -s ours strategy does not actually bring any change to the target branch, thus if needed you might want to bring the changes from the HotFix to master by creating a another MR which cherry-picks the merge commit in release for the given HotFix.

Use the difference to first parent for the cherry-pick commit:

git cherry-pick -m1 -x <HASH OF COMMIT>