SMTK issueshttps://gitlab.kitware.com/cmb/smtk/-/issues2022-06-06T16:13:42-04:00https://gitlab.kitware.com/cmb/smtk/-/issues/482Rename or remove qtDoubleClickButton::clicked()2022-06-06T16:13:42-04:00David ThompsonRename or remove qtDoubleClickButton::clicked()Some platforms emit a warning that `clicked()` is a non-virtual function with the same name as a virtual method in its parent class.
If we can re-use the parent signal, we should remove `clicked()`. If not, we should rename it.Some platforms emit a warning that `clicked()` is a non-virtual function with the same name as a virtual method in its parent class.
If we can re-use the parent signal, we should remove `clicked()`. If not, we should rename it.Aron HelserAron Helserhttps://gitlab.kitware.com/cmb/smtk/-/issues/471Expressions with an underscore in a variable name fail to evaluate2022-06-27T10:11:20-04:00David ThompsonExpressions with an underscore in a variable name fail to evaluateTo reproduce:
1. Create an expression named `infixExpression_0` and set its symbolic value to 0
2. Create a second expression named `infixExpression_1` and set its symbolic value to `{infixExpression_0}`. This will show "Evaluation fail...To reproduce:
1. Create an expression named `infixExpression_0` and set its symbolic value to 0
2. Create a second expression named `infixExpression_1` and set its symbolic value to `{infixExpression_0}`. This will show "Evaluation failed" for its computed value.
As a workaround, rename `infixExpression_0` to `infixExpression0` and update `infixExpression_1`'s symbolic value. The computed value will now be correct.
@jwilson1881 @rohit.krishnaAron HelserAron Helserhttps://gitlab.kitware.com/cmb/smtk/-/issues/278smtk::io::Logger is not thread-safe2019-10-17T22:25:46-04:00Robert M. O'Barasmtk::io::Logger is not thread-safeThis can cause a problem with multi-threaded code.This can cause a problem with multi-threaded code.Robert M. O'BaraRobert M. O'Barahttps://gitlab.kitware.com/cmb/smtk/-/issues/254Need a simpler UI for setting Reference Items2019-07-12T13:00:59-04:00Robert M. O'BaraNeed a simpler UI for setting Reference ItemsNeed to be able to use a simple ComboBox like interface to set items that are non-extensible and only contain a single value.
In addition it should provide an option to restrict its choices to those directly associated to the item's att...Need to be able to use a simple ComboBox like interface to set items that are non-extensible and only contain a single value.
In addition it should provide an option to restrict its choices to those directly associated to the item's attributehttps://gitlab.kitware.com/cmb/smtk/-/issues/249Improvements needed for qtFileItem2019-10-17T22:27:05-04:00Robert M. O'BaraImprovements needed for qtFileItemThe class should have the following improvements:
* Take into consideration the ShouldExists hint associated with the item's definition. This should include both when setting the value or when loading the attribute resource into memory...The class should have the following improvements:
* Take into consideration the ShouldExists hint associated with the item's definition. This should include both when setting the value or when loading the attribute resource into memory.
* Not record every key press as a new filename being entered.Robert M. O'BaraRobert M. O'Barahttps://gitlab.kitware.com/cmb/smtk/-/issues/239SMTK Item Find Methods in Attribute and Items limitations2019-06-06T16:14:10-04:00Robert M. O'BaraSMTK Item Find Methods in Attribute and Items limitationsAttribute::find will not take GroupItems into consideration
ValueItem::findChild will not take GroupItems into consideration
GroupItem::find will not take ValueItems into consideration.
Also you can not just get top level active items.Attribute::find will not take GroupItems into consideration
ValueItem::findChild will not take GroupItems into consideration
GroupItem::find will not take ValueItems into consideration.
Also you can not just get top level active items.Robert M. O'BaraRobert M. O'Barahttps://gitlab.kitware.com/cmb/smtk/-/issues/138meshes do not ship point info via JSON2017-04-12T18:20:43-04:00T.J. Coronameshes do not ship point info via JSONI am trying to display mesh information in ModelBuilder and have hit a bug where the number of cells is correct but the number of points is always 0. Looking into it, I notice that the [mesh JSON interface does not send points](smtk/mesh...I am trying to display mesh information in ModelBuilder and have hit a bug where the number of cells is correct but the number of points is always 0. Looking into it, I notice that the [mesh JSON interface does not send points](smtk/mesh/json/Interface.cxx#L309). Is there a reason for this, or was this simply an oversight?SMTK 1.1Robert MaynardRobert Maynardhttps://gitlab.kitware.com/cmb/smtk/-/issues/137Redesign selection manager2018-04-11T01:59:24-04:00Haocheng LIURedesign selection manager* [x] Clean up the legacy selection update code in CMB.
* [x] One signal in, one signal out. qtSelectionManager should not send multiple signals out.
* [x] Use a relay mechanism to decide who is the sender. if qSM is sending signal ou...* [x] Clean up the legacy selection update code in CMB.
* [x] One signal in, one signal out. qtSelectionManager should not send multiple signals out.
* [x] Use a relay mechanism to decide who is the sender. if qSM is sending signal out, relay = false. If consumer is sending selection to qSM, relay = true.
* [x] Use a list to realize functionality that user might only want to update partial consumers.
Haocheng LIUHaocheng LIUhttps://gitlab.kitware.com/cmb/smtk/-/issues/418SMTK ghostflow should look for restructured-text release notes2021-04-14T10:04:18-04:00David ThompsonSMTK ghostflow should look for restructured-text release notesPlease modify the ghostflow configuration for cmb/smtk> MRs to look for `.rst` files in `doc/release/notes` instead of `.md` files. If you want to test, see !2415 which has an RST note.Please modify the ghostflow configuration for cmb/smtk> MRs to look for `.rst` files in `doc/release/notes` instead of `.md` files. If you want to test, see !2415 which has an RST note.Brad KingBrad Kinghttps://gitlab.kitware.com/cmb/smtk/-/issues/288smtk::Analyses::Analysis - not always using Labels in GUI2020-01-31T11:39:48-05:00Robert M. O'Barasmtk::Analyses::Analysis - not always using Labels in GUIWhen dealing with Exclusive children, sometimes the analysis' label is ignored and the type is used instead.When dealing with Exclusive children, sometimes the analysis' label is ignored and the type is used instead.Robert M. O'BaraRobert M. O'Barahttps://gitlab.kitware.com/cmb/smtk/-/issues/161operator callbacks: convert from function pointers to std::functions2018-02-15T14:16:44-05:00T.J. Coronaoperator callbacks: convert from function pointers to std::functionsFrom !895:
> we have moved to c++11 since this was written. We should probably switch to `using Callback = std::function<int(EventType, OperatorPtr)>` instead of this typedef. Similarly for `CallbackWithResult` below.
> The only complic...From !895:
> we have moved to c++11 since this was written. We should probably switch to `using Callback = std::function<int(EventType, OperatorPtr)>` instead of this typedef. Similarly for `CallbackWithResult` below.
> The only complication is that `observe()` should probably return a handle so that `unobserve()` can work. Otherwise, it will be impossible to unobserve in-place lambdas.https://gitlab.kitware.com/cmb/smtk/-/issues/160Clear Selection after Operator Completes2018-01-18T17:27:42-05:00Amanda HinesClear Selection after Operator CompletesOnce an operation applies, the selection should be cleared.Once an operation applies, the selection should be cleared.Haocheng LIUHaocheng LIUhttps://gitlab.kitware.com/cmb/smtk/-/issues/139Improvements for Active model logic2017-04-28T20:26:55-04:00Haocheng LIUImprovements for Active model logic* [x] save/close operator would list all models(active and non-active)
* [x] model operator(Ex. Add-Image) should only be allowed to applied to active model
* [x] BUG: switch active model and load image would not trigger model tree to up...* [x] save/close operator would list all models(active and non-active)
* [x] model operator(Ex. Add-Image) should only be allowed to applied to active model
* [x] BUG: switch active model and load image would not trigger model tree to update.SMTK 1.1Haocheng LIUHaocheng LIUhttps://gitlab.kitware.com/cmb/smtk/-/issues/82Default value for the ADH Surfacewater python exporter script is incorrect if...2018-04-11T01:59:25-04:00Amanda HinesDefault value for the ADH Surfacewater python exporter script is incorrect if workflows aren't installed in ModelBuilder directory on Mac OSI installed the workflows in a different directory than the ModelBuilder Contents directory on my Mac (10.11.5). When I went to export the simulation, the default script was set to ADHSurfacewater.py but I received the following error wh...I installed the workflows in a different directory than the ModelBuilder Contents directory on my Mac (10.11.5). When I went to export the simulation, the default script was set to ADHSurfacewater.py but I received the following error when I tried to export:
```
No python script specified
```
When I set it to the script in the workflows directory, it exported (the box showed the full path to the script). Is it possible to update that default box with the path of the loaded template?John TourtellottJohn Tourtellotthttps://gitlab.kitware.com/cmb/smtk/-/issues/11Shiboken wrap files rebuilt every time CMake reruns2018-04-11T01:59:25-04:00Ben BoeckelShiboken wrap files rebuilt every time CMake rerunshttps://gitlab.kitware.com/cmb/smtk/-/issues/525Create 24.01 Release2024-03-12T13:03:38-04:00Robert M. O'BaraCreate 24.01 Release<!--
This template is for tracking a release of smtk. Please replace the
following strings with the associated values:
- `VERSION`: e.g. yy.mm.n
- `MAJOR`: e.g. yy is the year
- `MINOR`: e.g. mm is the month
- `PATCH`: e.g. the ...<!--
This template is for tracking a release of smtk. Please replace the
following strings with the associated values:
- `VERSION`: e.g. yy.mm.n
- `MAJOR`: e.g. yy is the year
- `MINOR`: e.g. mm is the month
- `PATCH`: e.g. the release sequence number (start at 0)
- `BRANCHPOINT`: The commit where the release should be started - it is a point on master where the release process branch is started from. The release process branch will have multiple commits including the assembling of release notes and changing of the version.
Please remove this comment.
-->
# Preparatory steps
- Make sure you have run the `utility/SetupForDevelopment.sh` script.
- Update smtk guides
# Update smtk
- Update the local copy of the base branch.
- If `PATCH` is 0, update `master`
- Otherwise, update `release`
- [ ] `git fetch origin`
- [ ] `git checkout $branch`
- [ ] `git merge --ff-only origin/$branch`
- If this fails, there are local commits that need to be removed
- Ensure that changes intended for the release are in it.
- The [`backport-mrs.py`][backport-mrs] script can be used to find and
ensure that merge requests assigned to the associated milestone are
available on the `release` branch. See its documentation for usage.
- Integrate changes.
- Create branch for release commits
- [ ] `git checkout -b update-to-v24.01.0 BRANCHPOINT`
- Make a commit for each of these `release`-only changes:
- [x] Assemble release notes into `doc/release/smtk-24.01.rst`.
- [x] Top of release notes should have `.. _release-notes-24.01:` and a reference to the previous release's notes (See `doc/release/smtk-21.07.rst` or later for an example.)
- [x] Add reference to new release notes to `doc/release/index.rst`. (This publishes release notes on read-the-docs.)
- [x] Update the ReadMe file to refer to the new release notes
- [x] If `PATCH` is greater than 0, add items to the end of this file.
- [x] `git rm` all of the individual release note files *except* `00-example.rst`.
- [x] Do a git add for ReadMe, index.rst, and smtk-24.01.rst
- [x] `git commit -m 'Compile release notes for 24.01.0'`
- [x] Update `version.txt` and tag the commit (tag this commit below)
- [x] `echo 24.01.0 > version.txt`
- [x] Rebuild smtk to check for deprecation warnings
- [x] `git commit -m 'Update version number to 24.01.0' version.txt` (commit message must be verbatum)
- [x] Update `.gitlab/ci/cdash-groups.json` to track the `release` CDash
groups.
- [x] Change "master" => "release" everywhere in `.gitlab/ci/cdash-groups.json`,
and change "latest-master" => "latest-release".
- [x] `git commit -m 'Update cdash-groups.json to track the release group' .gitlab/ci/cdash-groups.json`
- Create a merge request targeting `release`
- [x] Obtain a GitLab API token for the `kwrobot.release.cmb` user (ask
@ben.boeckel if you do not have one)
- [x] Add the `kwrobot.release.cmb` user to your fork with at least
`Developer` privileges (so it can open MRs)
- [x] Use [the `release-mr`][release-mr] script to open the create the
Merge Request (see script for usage)
- Pull the script for each release; it may have been updated since it
was last used
- The script outputs the information it will be using to create the
merge request. Please verify that it is all correct before creating
the merge request. See usage at the top of the script to provide
information that is either missing or incorrect (e.g., if its data
extraction heuristics fail).
- [x] Get positive review
- [x] Get a repo maintainer (currently Ben) or owner (currently Bob) to`Do: merge`
- [x] Get a repo maintainer or ownder to push the tag to the main repository
- [x] `git tag -a -m 'SMTK 24.01.0' v24.01.0 commit-that-updated-version.txt`
- [x] `git push origin v24.01.0`
- Software process updates (these can all be done independently)
- [x] Update kwrobot with the new `release` branch rules (@ben.boeckel)
- [x] Run [this script][cdash-update-groups] to update the CDash groups
- This must be done after a nightly run to ensure all builds are in the
`release` group
- See the script itself for usage documentation
- [x] Add (or update if `PATCH` is greater than 0) version selection entry
in cmb-superbuild
[backport-mrs]: https://gitlab.kitware.com/utils/release-utils/-/blob/master/backport-mrs.py
[release-mr]: https://gitlab.kitware.com/utils/release-utils/-/blob/master/release-mr.py
[cdash-update-groups]: https://gitlab.kitware.com/utils/cdash-utils/-/blob/master/cdash-update-groups.py
# Post-release
- [x] Write and publish blog post with release notes.
- [x] Post an announcement in the Announcements category on
[discourse.smtk.org](https://discourse.kitware.com/c/smtk/).
- [x] Create a new commit on `master` that does the following:
- [x] Remove the deprecated methods on `master`. Note that it should be discussed before hand which deprecated methods should be removed in this release.
- [x] Set the version.txt on `master` to be yy.mm.100
/cc @ben.boeckel
/cc @bob.obara
/cc @dcthompRobert M. O'BaraRobert M. O'Barahttps://gitlab.kitware.com/cmb/smtk/-/issues/508Release SMTK 23.04.02023-07-06T16:34:41-04:00Robert M. O'BaraRelease SMTK 23.04.0
# Preparatory steps
- Make sure you have run the `utility/SetupForDevelopment.sh` script.
- Update smtk guides
# Update smtk
- Update the local copy of the base branch.
- If `PATCH` is 0, update `master`
- Otherwise, u...
# Preparatory steps
- Make sure you have run the `utility/SetupForDevelopment.sh` script.
- Update smtk guides
# Update smtk
- Update the local copy of the base branch.
- If `PATCH` is 0, update `master`
- Otherwise, update `release`
- [x] `git fetch origin`
- [x] `git checkout $branch`
- [x] `git merge --ff-only origin/$branch`
- If this fails, there are local commits that need to be removed
- Ensure that changes intended for the release are in it.
- The [`backport-mrs.py`][backport-mrs] script can be used to find and
ensure that merge requests assigned to the associated milestone are
available on the `release` branch. See its documentation for usage.
- Integrate changes.
- Create branch for release commits
- [x] `git checkout -b update-to-v23.04.0 bcf281df3db8c9424761e7c3069233950ee77d95`
- Make a commit for each of these `release`-only changes:
- [x] Assemble release notes into `doc/release/smtk-23.04.rst`.
- [x] Top of release notes should have `.. _release-notes-23.04:` and a reference to the previous release's notes (See `doc/release/smtk-21.07.rst` or later for an example.)
- [x] Add reference to new release notes to `doc/release/index.rst`. (This publishes release notes on read-the-docs.)
- [x] Update the ReadMe file to refer to the new release notes
- [x] If `PATCH` is greater than 0, add items to the end of this file.
- [x] `git rm` all of the individual release note files *except* `00-example.rst`.
- [x] Do a git add for ReadMe, index.rst, and smtk-23.04.rst
- [x] `git commit -m 'Compile release notes for 23.04.0'`
- [ ] Update `version.txt` and tag the commit (tag this commit below)
- [x] `echo 23.04.0 > version.txt`
- [x] Rebuild smtk to check for deprecation warnings
- [ ] `git commit -m 'Update version number to 23.04.0' version.txt` (commit message must be verbatum)
- [ ] Update `.gitlab/ci/cdash-groups.json` to track the `release` CDash
groups.
- [x] Change "master" => "release" everywhere in `.gitlab/ci/cdash-groups.json`,
and change "latest-master" => "latest-release".
- [x] `git commit -m 'Update cdash-groups.json to track the release group' .gitlab/ci/cdash-groups.json`
- Create a merge request targeting `release`
- [x] Obtain a GitLab API token for the `kwrobot.release.cmb` user (ask
@ben.boeckel if you do not have one)
- [x] Add the `kwrobot.release.cmb` user to your fork with at least
`Developer` privileges (so it can open MRs)
- [x] Use [the `release-mr`][release-mr] script to open the create the
Merge Request (see script for usage)
- Pull the script for each release; it may have been updated since it
was last used
- The script outputs the information it will be using to create the
merge request. Please verify that it is all correct before creating
the merge request. See usage at the top of the script to provide
information that is either missing or incorrect (e.g., if its data
extraction heuristics fail).
- [x] Get positive review
- [x] Get a repo maintainer (currently Ben) or owner (currently Bob) to`Do: merge`
- [x] Get a repo maintainer or ownder to push the tag to the main repository
- [x] `git tag -a -m 'SMTK 23.04.0' v23.04.0 commit-that-updated-version.txt`
- [x] `git push origin v23.04.0`
- Software process updates (these can all be done independently)
- [x] Update kwrobot with the new `release` branch rules (@ben.boeckel)
- [x] Run [this script][cdash-update-groups] to update the CDash groups
- This must be done after a nightly run to ensure all builds are in the
`release` group
- See the script itself for usage documentation
- [ ] Add (or update if `PATCH` is greater than 0) version selection entry
in cmb-superbuild
[backport-mrs]: https://gitlab.kitware.com/utils/release-utils/-/blob/master/backport-mrs.py
[release-mr]: https://gitlab.kitware.com/utils/release-utils/-/blob/master/release-mr.py
[cdash-update-groups]: https://gitlab.kitware.com/utils/cdash-utils/-/blob/master/cdash-update-groups.py
# Post-release
- [ ] Write and publish blog post with release notes.
- [ ] Post an announcement in the Announcements category on
[discourse.smtk.org](https://discourse.kitware.com/c/smtk/).
- [ ] Create a new commit on `master` that does the following:
- [ ] Remove the deprecated methods on `master`. Note that it should be discussed before hand which deprecated methods should be removed in this release.
- [ ] Set the version.txt on `master` to be 23.04.100
/cc @ben.boeckel
/cc @bob.obara
/cc @dcthompRobert M. O'BaraRobert M. O'Barahttps://gitlab.kitware.com/cmb/smtk/-/issues/506Create SMTK 23.01 Release2023-02-24T14:51:13-05:00Robert M. O'BaraCreate SMTK 23.01 Release<!--
This template is for tracking a release of smtk. Please replace the
following strings with the associated values:
- `VERSION`: e.g. yy.mm.n
- `MAJOR`: e.g. yy is the year
- `MINOR`: e.g. mm is the month
- `PATCH`: e.g. the ...<!--
This template is for tracking a release of smtk. Please replace the
following strings with the associated values:
- `VERSION`: e.g. yy.mm.n
- `MAJOR`: e.g. yy is the year
- `MINOR`: e.g. mm is the month
- `PATCH`: e.g. the release sequence number (start at 0)
- `BRANCHPOINT`: The commit where the release should be started - it is a point on master where the release process branch is started from. The release process branch will have multiple commits including the assembling of release notes and changing of the version.
Please remove this comment.
-->
# Preparatory steps
- Make sure you have run the `utility/SetupForDevelopment.sh` script.
- Update smtk guides
# Update smtk
- Update the local copy of the base branch.
- If `PATCH` is 0, update `master`
- Otherwise, update `release`
- [x] `git fetch origin`
- [x] `git checkout $branch`
- [x] `git merge --ff-only origin/$branch`
- If this fails, there are local commits that need to be removed
- Ensure that changes intended for the release are in it.
- The [`backport-mrs.py`][backport-mrs] script can be used to find and
ensure that merge requests assigned to the associated milestone are
available on the `release` branch. See its documentation for usage.
- Integrate changes.
- Create branch for release commits
- [x] `git checkout -b update-to-v23.01.0 618a8290247a89a67ecfe2dfe4833d914c0aef13`
- Make a commit for each of these `release`-only changes:
- [ ] Assemble release notes into `doc/release/smtk-23.01.rst`.
- [x] Top of release notes should have `.. _release-notes-23.01:` and a reference to the previous release's notes (See `doc/release/smtk-21.07.rst` or later for an example.)
- [x] Add reference to new release notes to `doc/release/index.rst`. (This publishes release notes on read-the-docs.)
- [x] Update the ReadMe file to refer to the new release notes
- [ ] If `PATCH` is greater than 0, add items to the end of this file.
- [x] `git rm` all of the individual release note files *except* `00-example.rst`.
- [x] Do a git add for ReadMe, index.rst, and smtk-23.01.rst
- [x] `git commit -m 'Compile release notes for 23.01.0'`
- [ ] Update `version.txt` and tag the commit (tag this commit below)
- [x] `echo 23.01.0 > version.txt`
- [x] Rebuild smtk to check for deprecation warnings
- [x] `git commit -m 'Update version number to 23.01.0' version.txt` (commit message must be verbatum)
- [ ] Update `.gitlab/ci/cdash-groups.json` to track the `release` CDash
groups.
- [x] Change "master" => "release" everywhere in `.gitlab/ci/cdash-groups.json`,
and change "latest-master" => "latest-release".
- [x] `git commit -m 'Update cdash-groups.json to track the release group' .gitlab/ci/cdash-groups.json`
- Create a merge request targeting `release`
- [x] Obtain a GitLab API token for the `kwrobot.release.cmb` user (ask
@ben.boeckel if you do not have one)
- [x] Add the `kwrobot.release.cmb` user to your fork with at least
`Developer` privileges (so it can open MRs)
- [x] Use [the `release-mr`][release-mr] script to open the create the
Merge Request (see script for usage)
- Pull the script for each release; it may have been updated since it
was last used
- The script outputs the information it will be using to create the
merge request. Please verify that it is all correct before creating
the merge request. See usage at the top of the script to provide
information that is either missing or incorrect (e.g., if its data
extraction heuristics fail).
- [x] Get positive review
- [x] Get a repo maintainer (currently Ben) or owner (currently Bob) to`Do: merge`
- [ ] Get a repo maintainer or ownder to push the tag to the main repository
- [x] `git tag -a -m 'SMTK 23.01.0' v23.01.0 commit-that-updated-version.txt`
- [x] `git push origin v23.01.0`
- Software process updates (these can all be done independently)
- [x] Update kwrobot with the new `release` branch rules (@ben.boeckel)
- [x] Run [this script][cdash-update-groups] to update the CDash groups
- This must be done after a nightly run to ensure all builds are in the
`release` group
- See the script itself for usage documentation
- [ ] Add (or update if `PATCH` is greater than 0) version selection entry
in cmb-superbuild
[backport-mrs]: https://gitlab.kitware.com/utils/release-utils/-/blob/master/backport-mrs.py
[release-mr]: https://gitlab.kitware.com/utils/release-utils/-/blob/master/release-mr.py
[cdash-update-groups]: https://gitlab.kitware.com/utils/cdash-utils/-/blob/master/cdash-update-groups.py
# Post-release
- [x] Write and publish blog post with release notes.
- [x] Post an announcement in the Announcements category on
[discourse.smtk.org](https://discourse.kitware.com/c/smtk/).
- [x] Create a new commit on `master` that does the following:
- [x] Remove the deprecated methods on `master`. Note that it should be discussed before hand which deprecated methods should be removed in this release.
- [x] Set the version.txt on `master` to be 23.01.100
/cc @ben.boeckel
/cc @bob.obara
/cc @dcthompRobert M. O'BaraRobert M. O'Barahttps://gitlab.kitware.com/cmb/smtk/-/issues/503Create SMTK 22.11 Release2023-01-27T11:46:40-05:00Robert M. O'BaraCreate SMTK 22.11 Release<!--
This template is for tracking a release of smtk. Please replace the
following strings with the associated values:
- `VERSION`: e.g. yy.mm.n
- `MAJOR`: e.g. yy is the year
- `MINOR`: e.g. mm is the month
- `PATCH`: e.g. the ...<!--
This template is for tracking a release of smtk. Please replace the
following strings with the associated values:
- `VERSION`: e.g. yy.mm.n
- `MAJOR`: e.g. yy is the year
- `MINOR`: e.g. mm is the month
- `PATCH`: e.g. the release sequence number (start at 0)
- `BRANCHPOINT`: The commit where the release should be started - it is a point on master where the release process branch is started from. The release process branch will have multiple commits including the assembling of release notes and changing of the version.
Please remove this comment.
-->
# Preparatory steps
- Make sure you have run the `utility/SetupForDevelopment.sh` script.
- Update smtk guides
# Update smtk
- Update the local copy of the base branch.
- If `PATCH` is 0, update `master`
- Otherwise, update `release`
- [x] `git fetch origin`
- [x] `git checkout $branch`
- [x] `git merge --ff-only origin/$branch`
- If this fails, there are local commits that need to be removed
- Ensure that changes intended for the release are in it.
- The [`backport-mrs.py`][backport-mrs] script can be used to find and
ensure that merge requests assigned to the associated milestone are
available on the `release` branch. See its documentation for usage.
- Integrate changes.
- Create branch for release commits
- [x] `git checkout -b update-to-v22.11.0 752dcc77e2df12fc1306ce42049a4bcdf1e533ba`
- Make a commit for each of these `release`-only changes:
- [x] Assemble release notes into `doc/release/smtk-22.11.rst`.
- [x] Top of release notes should have `.. _release-notes-22.11:` and a reference to the previous release's notes (See `doc/release/smtk-21.07.rst` or later for an example.)
- [x] Add reference to new release notes to `doc/release/index.rst`. (This publishes release notes on read-the-docs.)
- [x] Update the ReadMe file to refer to the new release notes
- [x] If `PATCH` is greater than 0, add items to the end of this file.
- [x] `git rm` all of the individual release note files *except* `00-example.rst`.
- [x] Do a git add for ReadMe, index.rst, and smtk-22.11.rst
- [x] `git commit -m 'Compile release notes for 22.11.0'`
- [x] Update `version.txt` and tag the commit (tag this commit below)
- [x] `echo 22.11.0 > version.txt`
- [x] Rebuild smtk to check for deprecation warnings
- [x] `git commit -m 'Update version number to 22.11.0' version.txt` (commit message must be verbatum)
- [x] Update `.gitlab/ci/cdash-groups.json` to track the `release` CDash
groups.
- [x] Change "master" => "release" everywhere in `.gitlab/ci/cdash-groups.json`,
and change "latest-master" => "latest-release".
- [x] `git commit -m 'Update cdash-groups.json to track the release group' .gitlab/ci/cdash-groups.json`
- Create a merge request targeting `release`
- [x] Obtain a GitLab API token for the `kwrobot.release.cmb` user (ask
@ben.boeckel if you do not have one)
- [x] Add the `kwrobot.release.cmb` user to your fork with at least
`Developer` privileges (so it can open MRs)
- [x] Use [the `release-mr`][release-mr] script to open the create the
Merge Request (see script for usage)
- Pull the script for each release; it may have been updated since it
was last used
- The script outputs the information it will be using to create the
merge request. Please verify that it is all correct before creating
the merge request. See usage at the top of the script to provide
information that is either missing or incorrect (e.g., if its data
extraction heuristics fail).
- [x] Get positive review
- [x] Get a repo maintainer (currently Ben) or owner (currently Bob) to`Do: merge`
- [x] Get a repo maintainer or ownder to push the tag to the main repository
- [x] `git tag -a -m 'SMTK 22.11.0' v22.11.0 commit-that-updated-version.txt`
- [x] `git push origin v22.11.0`
- Software process updates (these can all be done independently)
- [x] Update kwrobot with the new `release` branch rules (@ben.boeckel)
- [x] Run [this script][cdash-update-groups] to update the CDash groups
- This must be done after a nightly run to ensure all builds are in the
`release` group
- See the script itself for usage documentation
- [ ] Add (or update if `PATCH` is greater than 0) version selection entry
in cmb-superbuild
[backport-mrs]: https://gitlab.kitware.com/utils/release-utils/-/blob/master/backport-mrs.py
[release-mr]: https://gitlab.kitware.com/utils/release-utils/-/blob/master/release-mr.py
[cdash-update-groups]: https://gitlab.kitware.com/utils/cdash-utils/-/blob/master/cdash-update-groups.py
# Post-release
- [ ] Write and publish blog post with release notes.
- [ ] Post an announcement in the Announcements category on
[discourse.smtk.org](https://discourse.kitware.com/c/smtk/).
- [x] Create a new commit on `master` that does the following:
- [x] Remove the deprecated methods on `master`. Note that it should be discussed before hand which deprecated methods should be removed in this release.
- [x] Set the version.txt on `master` to be yy.mm.100
/cc @ben.boeckel
/cc @bob.obara
/cc @dcthompRobert M. O'BaraRobert M. O'Barahttps://gitlab.kitware.com/cmb/smtk/-/issues/496Create SMTK 22.08.0 Release2022-11-28T11:22:57-05:00Robert M. O'BaraCreate SMTK 22.08.0 Release<!--
This template is for tracking a release of smtk. Please replace the
following strings with the associated values:
- `VERSION`: e.g. yy.mm.n
- `MAJOR`: e.g. yy is the year
- `MINOR`: e.g. mm is the month
- `PATCH`: e.g. the ...<!--
This template is for tracking a release of smtk. Please replace the
following strings with the associated values:
- `VERSION`: e.g. yy.mm.n
- `MAJOR`: e.g. yy is the year
- `MINOR`: e.g. mm is the month
- `PATCH`: e.g. the release sequence number (start at 0)
- `BRANCHPOINT`: The commit where the release should be started - it is a point on master where the release process branch is started from. The release process branch will have multiple commits including the assembling of release notes and changing of the version.
Please remove this comment.
-->
# Preparatory steps
- Make sure you have run the `utility/SetupForDevelopment.sh` script.
- Update smtk guides
# Update smtk
- Update the local copy of the base branch.
- If `PATCH` is 0, update `master`
- Otherwise, update `release`
- [x] `git fetch origin`
- [x] `git checkout $branch`
- [x] `git merge --ff-only origin/$branch`
- If this fails, there are local commits that need to be removed
- Ensure that changes intended for the release are in it.
- The [`backport-mrs.py`][backport-mrs] script can be used to find and
ensure that merge requests assigned to the associated milestone are
available on the `release` branch. See its documentation for usage.
- Integrate changes.
- Create branch for release commits
- [x] `git checkout -b update-to-v22.08.0 9242a022fd65206adae3691bfc4ac3c8f441972b`
- Make a commit for each of these `release`-only changes:
- [x] Assemble release notes into `doc/release/smtk-22.08.rst`.
- [x] Top of release notes should have `.. _release-notes-22.08:` and a reference to the previous release's notes (See `doc/release/smtk-21.07.rst` or later for an example.)
- [x] Add reference to new release notes to `doc/release/index.rst`. (This publishes release notes on read-the-docs.)
- [x] Update the ReadMe file to refer to the new release notes
- [x] If `PATCH` is greater than 0, add items to the end of this file.
- [x] `git rm` all of the individual release note files *except* `00-example.rst`.
- [x] Do a git add for ReadMe, index.rst, and smtk-22.08.rst
- [x] `git commit -m 'Compile release notes for 22.08.0'`
- [ ] Update `version.txt` and tag the commit (tag this commit below)
- [x] `echo 22.08.0 > version.txt`
- [x] Rebuild smtk to check for deprecation warnings
- [x] `git commit -m 'Update version number to 22.08.0' version.txt` (commit message must be verbatum)
- [x] Update `.gitlab/ci/cdash-groups.json` to track the `release` CDash
groups.
- [x] Change "master" => "release" everywhere in `.gitlab/ci/cdash-groups.json`,
and change "latest-master" => "latest-release".
- [x] `git commit -m 'Update cdash-groups.json to track the release group' .gitlab/ci/cdash-groups.json`
- Create a merge request targeting `release`
- [x] Obtain a GitLab API token for the `kwrobot.release.cmb` user (ask
@ben.boeckel if you do not have one)
- [x] Add the `kwrobot.release.cmb` user to your fork with at least
`Developer` privileges (so it can open MRs)
- [x] Use [the `release-mr`][release-mr] script to open the create the
Merge Request (see script for usage)
- Pull the script for each release; it may have been updated since it
was last used
- The script outputs the information it will be using to create the
merge request. Please verify that it is all correct before creating
the merge request. See usage at the top of the script to provide
information that is either missing or incorrect (e.g., if its data
extraction heuristics fail).
- [x] Get positive review
- [x] Get a repo maintainer (currently Ben) or owner (currently Bob) to`Do: merge`
- [x] Get a repo maintainer or ownder to push the tag to the main repository
- [x] `git tag -a -m 'SMTK 22.08.0' v22.08.0 commit-that-updated-version.txt`
- [x] `git push origin v22.08.0`
- Software process updates (these can all be done independently)
- [x] Update kwrobot with the new `release` branch rules (@ben.boeckel)
- [x] Run [this script][cdash-update-groups] to update the CDash groups
- This must be done after a nightly run to ensure all builds are in the
`release` group
- See the script itself for usage documentation
- [ ] Add (or update if `PATCH` is greater than 0) version selection entry
in cmb-superbuild
[backport-mrs]: https://gitlab.kitware.com/utils/release-utils/-/blob/master/backport-mrs.py
[release-mr]: https://gitlab.kitware.com/utils/release-utils/-/blob/master/release-mr.py
[cdash-update-groups]: https://gitlab.kitware.com/utils/cdash-utils/-/blob/master/cdash-update-groups.py
# Post-release
- [ ] Write and publish blog post with release notes.
- [ ] Post an announcement in the Announcements category on
[discourse.smtk.org](https://discourse.kitware.com/c/smtk/).
- [x] Create a new commit on `master` that does the following:
- [ ] Remove the deprecated methods on `master`. Note that it should be discussed before hand which deprecated methods should be removed in this release.
- [x] Set the version.txt on `master` to be yy.mm.100
/cc @ben.boeckel
/cc @bob.obara
/cc @dcthompRobert M. O'BaraRobert M. O'Bara