Skip to content
Snippets Groups Projects
Commit ec247536 authored by Mathieu Westphal (Kitware)'s avatar Mathieu Westphal (Kitware) :zap:
Browse files

Doc: Update release process doc

parent cdc1371e
No related branches found
No related tags found
No related merge requests found
......@@ -4,6 +4,8 @@
"maintainers": [
"ben.boeckel",
"berkgeveci",
"vbolea"
"vbolea",
"sankhesh",
"mwestphal"
]
}
......@@ -12,14 +12,19 @@ features.
VTK releases are named with a `Major.Minor.Patch` scheme.
VTK releases are handled by the VTK release group, which currently consists of:
- @vbolea
- @sankhesh
- @mwestphal
## Branching Scheme
The overall release history resembles a skinny tree. Development proceeds along
the `master` branch, consisting of topic branches that start from and are merged
into `master`. Every so often, a release is tagged and branched from it.
In general, no work takes place on the `release` branch, other than the handful
of important patches that make up occasional patch releases.
In general, no work takes place on the `release` branch, but some bug fixes from
master can be backported and will be used for occasional patch releases.
:::{hint}
Steps for contributing changes specific to the `release` branch are documented in
......@@ -36,11 +41,11 @@ The process for cutting releases is as follows:
1. Announce upcoming release
A few weeks before the intended `release` branch, announce on [VTK Discourse](https://discourse.vtk.org/)
that a new release is coming. This alerts developers to avoid making drastic
changes that might delay the release and gives them a chance to push important
and nearly completed features in time for the release. For example,
see [this post](https://discourse.vtk.org/t/vtk-9-2-0-release-cycle/8149).
A few weeks before the intended `release` branch, the VTK release group
announce on [VTK Discourse](https://discourse.vtk.org/) that a new release is coming.
This alerts developers to avoid making drastic changes that might delay the release
and gives them a chance to push important and nearly completed features in time for the release.
For example, see [this post](https://discourse.vtk.org/t/vtk-9-4-0-release/14577).
2. Polish the dashboards and bug tracker by addressing outstanding issue and
coordinate effort with relevant developers.
......@@ -48,6 +53,8 @@ The process for cutting releases is as follows:
Persistent compilation and regression test problems are fixed. Serious
outstanding bugs are fixed.
This is an effort involving the whole community of developers.
3. [Create a new issue](https://gitlab.kitware.com/vtk/vtk/-/issues/new) titled
`Release X.Y.Z[rcN]` based of the [new-release](https://gitlab.kitware.com/vtk/vtk/-/blob/master/.gitlab/issue_templates/new-release.md?plain=1) template.
......@@ -56,6 +63,8 @@ The process for cutting releases is as follows:
in the newly created issue.
:::
This is handled by the VTK release group.
4. Perform the release candidate cycle
1. Tag the release branch and create and publish release candidate
......@@ -72,12 +81,18 @@ The process for cutting releases is as follows:
3. If the community reports bugs, classify them in the bug tracker and ensure
they are fixed.
This is not handled by the VTK release group but by the whole community
of VTK developers.
Only serious bugs and regressions need to be fixed before the release.
Such merge requests must be acknowledged (`+1`) by the VTK release group
before being merged.
New features and minor problems should be merged into `master` as usual.
Patches for the release branch should start from the release branch, be
submitted through GitLab, and then merged into `master`. Once fully
tested there, the branch can be merged into the release branch.
tested there, reviewed and acknowloedge by the VTK release group,
the branch can be merged into the release branch.
When the selected issues are fixed in the release branch, tag the tip
of the release branch and release it as the next candidate, then the
......@@ -108,7 +123,7 @@ The process for cutting releases is as follows:
release for various platforms, so their input is especially valuable during
the release cycle.
The release manager also compiles release notes for the official release
The VTK release group also compiles release notes for the official release
announcement. Release notes are compiled from various [standardized topic documents](https://gitlab.kitware.com/vtk/vtk/-/tree/master/Documentation/release)
added to the `Documentation/release/dev` folder while features or issues
are fixed. The aggregation of these topic files is done manually and
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment