Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation on creating release. #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update documentation on creating release. #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion docs/update_castxml_version.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://data.kitware.com/#folder/57b5de948d777f10f2696370>`_.

First, build the artifacts which will be made available for download.

Update CastXML files
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's move this directly into https://github.com/CastXML/CastXMLSuperbuild/blob/master/README.rst adding a section like

Maintainers
-----------

* `How to update CastXML version ? <https://github.com/CastXML/CastXMLSuperbuild/blob/master/docs/make_a_release.rst>`_
* `How to make a release ? <https://github.com/CastXML/CastXMLSuperbuild/blob/master/docs/update_castxml_version.rst>`_

--------------------

Using the `CastXMLSuperbuild <https://github.com/CastXML/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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

create the folder ``vX.Y.Z``

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
Expand All @@ -30,6 +64,9 @@ Available CastXML archives can be found `here <https://data.kitware.com/#folder/
Updating tests/test_distribution.py
Updating tests/test_distribution.py - done

*Note*: Ensure that the ``Win32_binary`` variables still are set to the
content of the ``Win64_binary`` variable. It may be set to NULL.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead, let's fix the script:

CastXML-python-distributions/scripts/update_castxml_version.py

Lines 93 to 94 in 37c6977

set(win32_binary_url "NA") # Windows 32-bit binaries not available
set(win32_binary_sha512 "NA")

In the commit message updating the script, reference issue #5

Suggested change:

-      set(win32_binary_url    "NA")  # Windows 32-bit binaries not available
+      set(win32_binary_url    "${win64_binary_url}")  # See https://github.com/CastXML/CastXML-python-distributions/issues/5
-      set(win32_binary_sha512 "NA")
+      set(win32_binary_sha512 "${win64_binary_sha512}")

For some more context, see e03b460#diff-aa166f56653254a5ea3d6db905d61992


3. Create a topic named `update-to-castxml-X.Y.Z` and commit the changes.
For example::

Expand Down