diff --git a/docs/update_castxml_version.rst b/docs/update_castxml_version.rst index 255cb2f..932fb56 100644 --- a/docs/update_castxml_version.rst +++ b/docs/update_castxml_version.rst @@ -6,9 +6,43 @@ Updating the CastXML version A developer should use the following steps to update the version ``X.Y.Z`` of CastXML associated with the current CastXML python distributions. - Available CastXML archives can be found `here `_. +First, build the artifacts which will be made available for download. + +Update CastXML files +-------------------- + +Using the `CastXMLSuperbuild `_ +repository, create a merge request which will use CI to automatically generate +the appropriate binary files for the new version. The version selection is +controlled by the ``CastXML_GIT_TAG`` variable. + +If necessary, update the ``LLVM`` and ``clang`` versions. Both objects have +a ``<>_version`` and a ``<>_md5`` variable which need to be be updated at the +same time. + +Once the CI has finished, view the "Details" of each task. Follow the links +to view and download the archive files created by each task. After download, +extract the contents of the associated archive file. The content of each ZIP +file will be uploaded in the next step. + +Upload files to data.kitware.com +-------------------------------- + +To upload the files generated in the previous step, first create the folder for +the new version of CastXML within the CastXML archive. This can be done, after +signing in to the instance, by clicking on the folder button in the upper right +corner. + +**Note**: If the only option in the menu is *Download folder*, create an issue +in this repository asking for write permission to this folder. + +Create a folder with the same name as the version of ``CastXML_GIT_TAG`` and +upload the files from the previous step. + +Update links in current repository +---------------------------------- 1. Install `girder-client`:: $ pip install girder-client @@ -30,6 +64,9 @@ Available CastXML archives can be found `here