Commit 5aa17881 authored by Bob Obara's avatar Bob Obara

DOC: Adding Release Issue Template for GitLab

parent e7f32662
<!--
This template is for tracking a release of CMB. Please replace the
following strings with the associated values:
- `VERSION`
- `MAJOR`
- `MINOR`
Please remove this comment.
-->
# Preparatory steps
- Update CMB guides
- Assemble release notes into `doc/release/CMB-VERSION`.
- [ ] Get positive review and merge.
# Update CMB
Keep the relevant items for the kind of release this is.
If making a first release candidate from master, i.e., `vMAJOR.MINOR.0-RC1`:
- [ ] Update `master` branch for **cmb**
```
git fetch origin
git checkout master
git merge --ff-only origin/master
```
- [ ] Update `version.txt` and tag the commit
```
git checkout -b update-to-vVERSION
echo VERSION > version.txt
git commit -m 'Update version number to VERSION' version.txt
git tag -a -m 'CMB VERSION' vVERSION HEAD
```
- Integrate changes to `master` branch
- [ ] Create a merge request targeting `master` (do *not* add `Backport: release`)
- [ ] Get positive review
- [ ] `Do: merge`
- Updating SMTK
- [ ] Start SMTK's Release Process cmb/smtk#SMTK_RELEASE_ISSUE
- Integrate changes to `release` branch
- [ ] `git config -f .gitmodules submodule.thirdparty/smtk.branch release`
- [ ] `git commit -m 'release: follow SMTK's release branch' .gitmodules`
- [ ] `git push origin update-to-vVERSION:release vVERSION`
- [ ] Update kwrobot with the new `release` branch rules (@ben.boeckel)
# Update CMB-Superbuild
Keep the relevant items for the kind of release this is.
If making a first release candidate from master, i.e., `vMAJOR.MINOR.0-RC1`:
- [ ] Update `master` branch for **cmb/cmb-superbuild**
```
git fetch origin
git checkout master
git merge --ff-only origin/master
```
- Update `CMakeLists.txt`
- [ ] `git checkout -b update-to-vVERSION`
- [ ] Update PARAVIEW_VERSION_DEFAULT to the release version (without RC*)
- [ ] Set CMB source selections in `CMakeLists.txt` and force explicit
version in `CMakeLists.txt`:
```
# Force source selection setting here.
set(cmb_SOURCE_SELECTION "VERSION" CACHE STRING "Force version to VERSION" FORCE)
set(cmb_FROM_SOURCE_DIR OFF CACHE BOOL "Force source dir off" FORCE)
```
- Update `versions.cmake`
- [ ] Guide selections in `versions.cmake`
- [ ] `git add versions.cmake CMakeLists.txt`
- [ ] `git commit -m "Update the default version to VERSION"`
- Integrate changes to `master` branch
- [ ] Create a merge request targeting `master`, title beginning with WIP (do *not* add `Backport: release` to description)
- [ ] Build binaries (`Do: test`)
- [ ] Download the binaries that have been generated in the dashboard results. They will be deleted within 24 hours.
- [ ] Remove explicit version forcing added in CMakeLists.txt and force push
```
git add CMakeLists.txt
git commit --amend
git gitlab-push -f
```
- Finalize merge request
- [ ] Remove WIP from merge request title
- [ ] Get positive review
- [ ] `Do: merge`
- [ ] `git tag -a -m 'cmb superbuild VERSION' vVERSION HEAD`
- Integrate changes to `release` branch
- [ ] `git push origin update-to-vVERSION:release vVERSION`
- [ ] Update kwrobot with the new `release` branch rules
# Validating binaries
- Binary checklist
- [ ] macOS
- [ ] Linux
- [ ] Windows
# Upload binaries
- Upload binaries
- [ ] Ask @chuck.atkins to sign macOS binary
- [ ] Verify the binaries are uploaded
```
buildListing.sh
updateMD5sum.sh vMAJOR.MINOR
```
- [ ] Test download links on https://www.computationalmodelbuilding.org/download
<!--
If making a non-RC release:
# Upload documentation
- [ ] Verify documentation is uploaded and is correct
-->
# Post-release
- [ ] Write and publish blog post with release notes.
- [ ] Post an announcement in the Announcements category on
[discourse.cmb.org](https://discourse.kitware.com/c/cmb/).
/cc @ben.boeckel
/cc @bob.obara
/cc @tjcorona
/cc @dcthomp
/label ~"priority:required"
<!--
This template is for tracking a release of CMB. Please replace the
following strings with the associated values:
- `VERSION`
- `MAJOR`
- `MINOR`
Please remove this comment.
-->
# Preparatory steps
- Update CMB guides
- Assemble release notes into `doc/release/CMB-VERSION`.
- [ ] Get positive review and merge.
# Update CMB
If making a release from the `release` branch, e.g., `vMAJOR.MINOR.0-RC2 or above`:
- [ ] Update `release` branch for **cmb**
```
git fetch origin
git checkout release
git merge --ff-only origin/release
```
- [ ] Update `version.txt` and tag the commit
```
git checkout -b update-to-vVERSION
echo VERSION > version.txt
git commit -m 'Update version number to VERSION' version.txt
git tag -a -m 'CMB VERSION' vVERSION HEAD
```
- Integrate changes to `master` branch
- [ ] Create a merge request targeting `master` (do *not* add `Backport: release`)
- [ ] Get positive review
- [ ] `Do: merge`
- Integrate changes to `release` branch
- [ ] `git push origin update-to-vVERSION:release vVERSION`
# Update CMB-Superbuild
If making a release from the `release` branch, e.g., `vMAJOR.MINOR.0-RC2 or above`:
- Update `release` branch for **cmb/cmb-superbuild**
```
git fetch origin
git checkout release
git merge --ff-only origin/release
```
- Update `CMakeLists.txt`
- [ ] Set CMB source selections in `CMakeLists.txt` and force explicit
version in `CMakeLists.txt`:
```
# Force source selection setting here.
set(cmb_SOURCE_SELECTION "VERSION" CACHE STRING "Force version to VERSION" FORCE)
set(cmb_FROM_SOURCE_DIR OFF CACHE BOOL "Force source dir off" FORCE)
```
- Update `versions.cmake`
- [ ] Guide selections in `versions.cmake`
- [ ] `git add versions.cmake CMakeLists.txt`
- [ ] `git commit -m "Update the default version to VERSION"`
- Integrate changes to `master` branch
- [ ] Create a merge request targeting `master`, title beginning with WIP (do *not* add `Backport: release` to description)
- [ ] Build binaries (`Do: test`)
- [ ] Download the binaries that have been generated in the dashboard results. They will be deleted within 24 hours.
- [ ] Remove explicit version forcing added in CMakeLists.txt, amend the commit, and force push
```
git add CMakeLists.txt
git commit --amend
git gitlab-push -f
```
- Finalize merge request
- [ ] Remove WIP from merge request title
- [ ] Get positive review
- [ ] `Do: merge`
- [ ] `git tag -a -m 'ParaView superbuild VERSION' vVERSION HEAD`
- Integrate changes to `release` branch
- [ ] `git push origin update-to-vVERSION:release vVERSION`
# Validating binaries
- Binary checklist
- [ ] macOS
- [ ] Linux
- [ ] Windows
# Upload binaries
- Upload binaries
- [ ] Ask @chuck.atkins to sign macOS binary
- [ ] Verify the binaries are uploaded
```
buildListing.sh
updateMD5sum.sh vMAJOR.MINOR
```
- [ ] Test download links on https://www.computationalmodelbuilding.org/download
# Post-release
- [ ] Write and publish blog post with release notes.
- [ ] Post an announcement in the Announcements category on
[discourse.cmb.org](https://discourse.kitware.com/c/cmb/).
/cc @ben.boeckel
/cc @bob.obara
/cc @tjcorona
/cc @dcthomp
/label ~"priority:required"
<!--
This template is for tracking a release of CMB. Please replace the
following strings with the associated values:
- `VERSION`
- `MAJOR`
- `MINOR`
Please remove this comment.
-->
# Preparatory steps
- Update CMB guides
- Assemble release notes into `doc/release/CMB-VERSION`.
- [ ] Get positive review and merge.
# Update CMB
If making a release from the `release` branch, e.g., `vMAJOR.MINOR.0-RC2 or above`:
- [ ] Update `release` branch for **cmb**
```
git fetch origin
git checkout release
git merge --ff-only origin/release
```
- [ ] Update `version.txt` and tag the commit
```
git checkout -b update-to-vVERSION
echo VERSION > version.txt
git commit -m 'Update version number to VERSION' version.txt
git tag -a -m 'CMB VERSION' vVERSION HEAD
```
- Integrate changes to `master` branch
- [ ] Create a merge request targeting `master` (do *not* add `Backport: release`)
- [ ] Get positive review
- [ ] `Do: merge`
- Integrate changes to `release` branch
- [ ] `git push origin update-to-vVERSION:release vVERSION`
- Update documentation page
- [ ] See `https://github.com/Kitware/paraview-docs/blob/gh-pages/versions.json`
# Update CMB-Superbuild
If making a release from the `release` branch, e.g., `vMAJOR.MINOR.0-RC2 or above`:
- Update `release` branch for **cmb/cmb-superbuild**
```
git fetch origin
git checkout release
git merge --ff-only origin/release
```
- Update `CMakeLists.txt`
- [ ] Set CMB source selections in `CMakeLists.txt` and force explicit
version in `CMakeLists.txt`:
```
# Force source selection setting here.
set(cmb_SOURCE_SELECTION "VERSION" CACHE STRING "Force version to VERSION" FORCE)
set(cmb_FROM_SOURCE_DIR OFF CACHE BOOL "Force source dir off" FORCE)
```
- Update `versions.cmake`
- [ ] Guide selections in `versions.cmake`
- [ ] `git add versions.cmake CMakeLists.txt`
- [ ] `git commit -m "Update the default version to VERSION"`
- Integrate changes to `master` branch
- [ ] Create a merge request targeting `master`, title beginning with WIP (do *not* add `Backport: release` to description)
- [ ] Build binaries (`Do: test`)
- [ ] Download the binaries that have been generated in the dashboard results. They will be deleted within 24 hours.
- [ ] Remove explicit version forcing added in CMakeLists.txt, amend the commit, and force push
```
git add CMakeLists.txt
git commit --amend
git gitlab-push -f
```
- Finalize merge request
- [ ] Remove WIP from merge request title
- [ ] Get positive review
- [ ] `Do: merge`
- [ ] `git tag -a -m 'ParaView superbuild VERSION' vVERSION HEAD`
- Integrate changes to `release` branch
- [ ] `git push origin update-to-vVERSION:release vVERSION`
# Validating binaries
- Binary checklist
- [ ] macOS
- [ ] Linux
- [ ] Windows
# Upload binaries
- Upload binaries
- [ ] Ask @chuck.atkins to sign macOS binary
- [ ] Verify the binaries are uploaded
```
buildListing.sh
updateMD5sum.sh vMAJOR.MINOR
```
- [ ] Test download links on https://www.computationalmodelbuilding.org/download
# Upload documentation
- [ ] Verify documentation is uploaded and is correct
# Post-release
- [ ] Write and publish blog post with release notes.
- [ ] Post an announcement in the Announcements category on
[discourse.cmb.org](https://discourse.kitware.com/c/cmb/).
- [ ] Update release notes
(https://www.paraview.org/Wiki/ParaView_Release_Notes)
- [ ] Move unclosed issues to next release milestone in GitLab
/cc @ben.boeckel
/cc @bob.obara
/cc @tjcorona
/cc @dcthomp
/label ~"priority:required"
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment