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

Jump to bottom

Update release.rst for #137 #138

Merged
merged 4 commits into from
Nov 27, 2023
Merged

Update release.rst for #137 #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1a67758
Update release.rst for #137
anton-seaice Nov 7, 2023
7da5675
Update release.rst for review comments
anton-seaice Nov 21, 2023
5de1da0
Fix edit link in docs
anton-seaice Nov 21, 2023
f058865
Update docs/management/release.rst
dougiesquire Nov 22, 2023
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
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
12 changes: 9 additions & 3 deletions docs/management/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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 :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::
Expand All @@ -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
$ git push --tags
Loading