Shuenhoy/vtk-m
1
0
Fork 0
mirror of https://gitlab.kitware.com/vtk/vtk-m synced 2024-07-30 18:50:59 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity
dd2aa335e8
vtk-m/docs/ReleaseProcess.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

2.2 KiB
Raw Blame History

Release Process

Prologue

This document is divided in two parts:

  • A overview of the branching and release scheme used in VTK-m.
  • A concise instructions to get started with the release process.

The actual release process can be found at .gitlab/issue_templates/NewRelease.md.

Overview of the branching scheme

Our current scheme is composed of two branches: release and master.

While all of the development is performed in the master branch, once in a while when we want to do a release, we tag a commit in master and we push it to the release branch.

Also there are times when we want to get Hotfix that affects previous releases to the release branch, in this case we can also push the merge request commit with the fix into the release branch.

A not so simple example of how the branching scheme looks like can be found here:

# → git log --graph --decorate --oneline --all

*   2e9230d (master) Merge branch 'update'
|\  
| * 59279dd (HEAD -> release, tag: v1.0.1) v1.0.1 2nd release of VTKm
| * b60611b Add release notes for v1.0.1
| *   9d26451 Merge branch 'master' into update
| |\  
| |/  
|/|   
* | 75137e5 Unrelated commit
* | e982be0 Merge branch 'release'
|\| 
| *   f2c4eb6 Merge branch 'hotfix' into release
| |\  
| | * c1c2655 Hotfix
| |/  
* | e53df9e Unrelated commit
* | ec6b481 Unrelated commit
|/  
* 0742a47 (tag: v1.0.0) v1.0.0 1st release of VTKm
* 4fe993c Add release notes for v1.0.0

This will make the release branch to only contain tags and HotFix merges as shown in here:

# git log --graph --decorate --oneline --first-parent release

* 59279dd (HEAD -> release, tag: v1.0.1) v1.0.1 2nd release of VTKm
* b60611b Add release notes for v1.0.1
* 9d26451 Merge branch 'master' into update
* f2c4eb6 Merge branch 'hotfix' into release
* 0742a47 (tag: v1.0.0) v1.0.0 1st release of VTKm
* 4fe993c Add release notes for v1.0.0

Get started with a new Release

  1. Go to https://gitlab.kitware.com/vtkm/vtk-m/ and open a new issue.
  2. At the issue template dropdown menu select: NewRelease.md
  3. Now remove the comments and substitute the variables surrounded by @.
  4. Post the issue and follow the steps.