From 1a677583719776a2744d8223e456aead3e82f680 Mon Sep 17 00:00:00 2001 From: Anton Steketee <79179784+anton-seaice@users.noreply.github.com> Date: Tue, 7 Nov 2023 16:50:29 +1100 Subject: [PATCH 1/4] Update release.rst for #137 --- docs/management/release.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/management/release.rst b/docs/management/release.rst index e6300c52..74424e52 100644 --- a/docs/management/release.rst +++ b/docs/management/release.rst @@ -15,6 +15,13 @@ not include an update to the catalog on Gadi, skip the first two steps below: $ export RELEASE=vX.X.X $ cd bin $ qsub -v version=${RELEASE} build_all.sh + + #. 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 workaround:: + + $ 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 will be updated to point at the new version just created. Commit this update:: @@ -37,4 +44,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 From 7da56756140c2f90fcacb541ec6bf5b1abe2c24e Mon Sep 17 00:00:00 2001 From: Anton Steketee <79179784+anton-seaice@users.noreply.github.com> Date: Wed, 22 Nov 2023 09:15:05 +1100 Subject: [PATCH 2/4] Update release.rst for review comments --- docs/management/release.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/management/release.rst b/docs/management/release.rst index 74424e52..5b946e32 100644 --- a/docs/management/release.rst +++ b/docs/management/release.rst @@ -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 `_ 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 `_ 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 From 5de1da02c64f598a5f32d6f2d1309b09d23af791 Mon Sep 17 00:00:00 2001 From: Anton Steketee <79179784+anton-seaice@users.noreply.github.com> Date: Wed, 22 Nov 2023 09:19:22 +1100 Subject: [PATCH 3/4] Fix edit link in docs --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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", From f058865068e58c516e73b04003b1368434a9e3b8 Mon Sep 17 00:00:00 2001 From: Dougie Squire <42455466+dougiesquire@users.noreply.github.com> Date: Wed, 22 Nov 2023 16:16:13 +1100 Subject: [PATCH 4/4] Update docs/management/release.rst --- docs/management/release.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/management/release.rst b/docs/management/release.rst index 5b946e32..1505be8c 100644 --- a/docs/management/release.rst +++ b/docs/management/release.rst @@ -16,7 +16,7 @@ not include an update to the catalog on Gadi, skip the first two steps below: $ 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 `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` + 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"