Update PR Comment to be more helpful

.github/workflows/ci.yml

@@ -30,6 +30,22 @@ on:
 env:
   SPACK_YAML_MODEL_YQ: .spack.specs[0]
 jobs:
+  defaults:
+    name: Set Defaults
+    # Unfortunately, you can't set a dynamic default value based on `inputs` yet
+    runs-on: ubuntu-latest
+    outputs:
+      root-sbd: ${{ steps.root-sbd.outputs.default }}
+    steps:
+      - name: root-sbd
+        id: root-sbd
+        run: |
+          if [[ "${{ inputs.root-sbd }}" == "" ]]; then
+            echo "default=${{ inputs.model }}" >> $GITHUB_OUTPUT
+          else
+            echo "default=${{ inputs.root-sbd }}" >> $GITHUB_OUTPUT
+          fi
+
   validate-json:
     name: Validate JSON
     uses: access-nri/actions/.github/workflows/validate-json.yml@main
@@ -60,23 +76,15 @@ jobs:
   check-spack-yaml:
     name: Check spack.yaml
     runs-on: ubuntu-latest
+    needs:
+      - defaults
     permissions:
       pull-requests: write
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - name: Set root-sbd Default
-        id: default
-        # Unfortunately, you can't set a dynamic default value based on `inputs` yet
-        run: |
-          if [[ "${{ inputs.root-sbd }}" == "" ]]; then
-            echo "root-sbd=${{ inputs.model }}" >> $GITHUB_OUTPUT
-          else
-            echo "root-sbd=${{ inputs.root-sbd }}" >> $GITHUB_OUTPUT
-          fi
-
       - name: Validate ACCESS-NRI spack.yaml Restrictions
         uses: access-nri/build-cd/.github/actions/validate-spack-yaml@main
         with:
@@ -118,7 +126,7 @@ jobs:
           # for each of the modules
           for DEP in $DEPS; do
             DEP_VER=''
-            if [[ "$DEP" == "${{ steps.default.outputs.root-sbd }}" ]]; then
+            if [[ "$DEP" == "${{ needs.defaults.outputs.root-sbd }}" ]]; then
               DEP_VER=$(yq '.spack.specs[0] | split("@git.") | .[1]' spack.yaml)
             else
               DEP_VER=$(yq ".spack.packages.\"$DEP\".require[0] | split(\"@git.\") | .[1]" spack.yaml)
@@ -181,19 +189,21 @@ jobs:
     # This will create a `spack` environment with the name `<model>-pr<pull request number>-<commit number>`.
     # For example, `access-om3-pr13-3` for the deployment of access-om3 based on the third commit on the PR#13.
     needs:
+      - defaults  # so we can access `inputs.root-sbd` that could have defaulted to `inputs.model`
       - version-tag  # implies all the spack.yaml-related checks have passed, has appropriate version for the prerelease build
       - check-config  # implies all the json-related checks have passed
     uses: access-nri/build-cd/.github/workflows/deploy-1-setup.yml@main
     with:
       type: prerelease
       ref: ${{ github.head_ref }}
       version: ${{ needs.version-tag.outputs.prerelease }}
-      root-sbd: ${{ inputs.root-sbd }}
+      root-sbd: ${{ needs.defaults.outputs.root-sbd }}
     secrets: inherit
 
   notifier:
     name: Notifier
     needs:
+      - defaults  # so we can access `inputs.root-sbd` that could have defaulted to `inputs.model`
       - version-tag  # implies all the spack.yaml-related checks have passed, has appropriate version for the prerelease build
       - check-config  # implies all the json-related checks have passed
     runs-on: ubuntu-latest
@@ -203,13 +213,15 @@ jobs:
       - uses: access-nri/actions/.github/actions/pr-comment@main
         with:
           comment: |
-            This `${{ inputs.model }}` model will be deployed with the following versions:
+            This `${{ inputs.model }}` model will be deployed as:
             * `${{ needs.version-tag.outputs.release }}` as a Release (when merged).
-            * `${{ needs.version-tag.outputs.prerelease }}` as a Prerelease (during this PR). This can be accessed on `Gadi` via `spack` at `/g/data/vk83/prerelease/apps/spack/0.20/spack` once deployed.
+            * `${{ needs.version-tag.outputs.prerelease }}` as a Prerelease (during this PR).
+
+            This Prerelease is accessible on Gadi using `module use /g/data/vk83/prerelease/modules/access-models/ && module load ${{ needs.defaults.outputs.root-sbd }}/${{ needs.version-tag.outputs.prerelease }}`, where the binaries shall be on your `$PATH`.
+            This Prerelease is also accessible on Gadi via `/g/data/vk83/prerelease/apps/spack/0.21/spack` in the `${{ needs.defaults.outputs.root-sbd }}-${{ needs.version-tag.outputs.prerelease }}` environment.
 
             It will be deployed using:
             * `access-nri/spack-packages` version [`${{ needs.check-config.outputs.spack-packages-version }}`](https://github.com/ACCESS-NRI/spack-packages/releases/tag/${{ needs.check-config.outputs.spack-packages-version }})
             * `access-nri/spack-config` version [`${{ needs.check-config.outputs.spack-config-version }}`](https://github.com/ACCESS-NRI/spack-config/releases/tag/${{ needs.check-config.outputs.spack-config-version }})
 
             If this is not what was expected, commit changes to `config/versions.json`.
-

.github/workflows/deploy-1-setup.yml

@@ -18,7 +18,6 @@ on:
       root-sbd:
         type: string
         required: false
-        # default: The model name, taken from the callers repository name
         description: The root SBD that is being used as the modulefile name
 
 jobs:
@@ -30,8 +29,6 @@ jobs:
       model: ${{ steps.get-model.outputs.model }}
       # Spack env name in form <model>-<version>
       env-name: ${{ steps.get-env-name.outputs.env-name }}
-      # Root SBD that defaults to the model name
-      root-sbd: ${{ steps.set-root-sbd.outputs.root-sbd }}
     steps:
       - name: Get Model
         id: get-model
@@ -44,16 +41,6 @@ jobs:
         # replace occurences of '.' with '_' in environment name as spack doesn't support '.'. Ex: 'access-om2-v1.0.0' -> 'access-om2-v1_0_0'.
         run: echo "env-name=$(echo '${{ steps.get-model.outputs.model }}-${{ inputs.version }}' | tr '.' '_')" >> $GITHUB_OUTPUT
 
-      - name: Set Root SBD Default
-        id: set-root-sbd
-        # We set the default here because we don't have access to the modified repo name in the inputs section yet
-        run: |
-          if [[ "${{ inputs.root-sbd }}" == "" ]]; then
-            echo "root-sbd=${{ steps.get-model.outputs.model }}" >> $GITHUB_OUTPUT
-          else
-            echo "root-sbd=${{ inputs.root-sbd }}" >> $GITHUB_OUTPUT
-          fi
-
   setup-deployment-env:
     name: Setup Deployment Environment
     runs-on: ubuntu-latest
@@ -94,5 +81,5 @@ jobs:
       version: ${{ inputs.version }}
       env-name: ${{ needs.setup-spack-env.outputs.env-name }}
       deployment-environment: ${{ matrix.deployment-environment }}
-      root-sbd: ${{ needs.setup-spack-env.outputs.root-sbd }}
+      root-sbd: ${{ inputs.root-sbd }}
     secrets: inherit