Skip to content

Commit

Permalink
Update release.rst for review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
anton-seaice committed Nov 21, 2023
1 parent 1a67758 commit 7da5675
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/management/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,16 @@ person doing the release must ensure that the version of the new catalog matches
following all steps below. Steps 1 and 2 below should be done in a PR and merged before commencing step 3. If the release does
not include an update to the catalog on Gadi, skip the first two steps below:

#. [IF UPDATING THE CATALOG] Create a new version of the catalog on Gadi (this will take about 1 hour)::

#. [IF UPDATING THE CATALOG] Create a new version of the catalog on Gadi (this will take about 1 hour)
::
$ export RELEASE=vX.X.X
$ cd bin
$ qsub -v version=${RELEASE} build_all.sh

#. If the `schema <https://github.com/ACCESS-NRI/schema>`_ has changed, or you have not used the intake catalog recently, this step may fail with a *Network is unreachable* error trying to download the schema json files. To workaround::
.. note::
If the `schema <https://github.com/ACCESS-NRI/schema>`_ has changed, or you have not used the intake catalog recently, this step may fail with a *Network is unreachable* error trying to download the schema json files. To download and cache the schema, first import the `access_nri_intake.source` and `access_nri_intake.catalog` sub-packages from a Gadi node with network access (e.g. a login or ARE node). I.e., using the release version of `access_nri_intake`
::
$ python3 -c "from access_nri_intake import source, catalog"
$ module use /g/data/hh5/public/modules/; module load conda/analysis3
$ python3 -c "from access_nri_intake import source, catalog"

This will cache a copy of the schema in your home directory. Then re-run ``$ qsub -v version=${RELEASE} build_all.sh``

#. [IF UPDATING THE CATALOG] Upon successful completion of the previous step, the :code:`access_nri_intake` data package module
Expand Down

0 comments on commit 7da5675

Please sign in to comment.