diff --git a/docs/conf.py b/docs/conf.py index 27551a42..3952efc0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -75,7 +75,7 @@ html_theme = "sphinx_book_theme" html_static_path = ["_static"] html_context = { - "github_user": "dougiesquire", + "github_user": "ACCESS-NRI", "github_repo": "access-nri-intake-catalog", "github_version": "main", "doc_path": "./docs", diff --git a/docs/management/release.rst b/docs/management/release.rst index e6300c52..1505be8c 100644 --- a/docs/management/release.rst +++ b/docs/management/release.rst @@ -10,11 +10,17 @@ 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 + .. note:: + If the `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 :code:`access_nri_intake.source` and :code:`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 :code:`access_nri_intake` + :: + $ 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 will be updated to point at the new version just created. Commit this update:: @@ -37,4 +43,4 @@ Alternatively (though discouraged), one can trigger the new release from the com $ git fetch --all --tags $ git commit --allow-empty -m "Release $RELEASE" $ git tag -a $RELEASE -m "Version $RELEASE" - $ git push --tags \ No newline at end of file + $ git push --tags