Multi-HPC Workflows

.github/actions/get-deploy-paths/README.md

@@ -30,7 +30,7 @@ jobs:
     steps:
       - name: Get Deployment Paths
         id: paths
-        uses: access-nri/build-cd/.github/actions/get-deploy-paths@main
+        uses: access-nri/build-cd/.github/actions/get-deploy-paths@vX
         with:
           spack-installs-root-path: ${{ vars.SPACK_INSTALLS_ROOT_PATH }}
           spack-version: "0.21"

.github/actions/get-target-matrix/README.md

@@ -25,7 +25,7 @@ jobs:
       valid-targets: ${{ steps.generate.outputs.valid-targets }}
     steps:
       - id: generate
-        uses: access-nri/build-cd/.github/actions/get-target-matrix@main
+        uses: access-nri/build-cd/.github/actions/get-target-matrix@vX
         with:
           targets: ${{ vars.MODEL_REPO_TARGETS }}
 

.github/actions/get-target-matrix/action.yml

@@ -13,11 +13,16 @@ outputs:
 runs:
   using: composite
   steps:
+    - name: Get default branch
+      shell: bash
+      id: default
+      run: echo "branch=$(gh repo view access-nri/build-cd --json defaultBranchRef --jq '.[].name')" >> $GITHUB_OUTPUT
+
     - name: Get deployment settings.json
       uses: actions/checkout@v4
       with:
         repository: access-nri/build-cd
-        ref: main
+        ref: ${{ steps.default.outputs.branch }}
 
     - name: Generate Deployment Target Matrix
       shell: bash

.github/actions/validate-deployment-settings/README.md

@@ -22,7 +22,7 @@ This action validates various `ACCESS-NRI/build-cd` deployment settings.
 # ...
 - name: Validate settings
   id: settings
-  uses: access-nri/build-cd/.github/actions/validate-deployment-settings@main
+  uses: access-nri/build-cd/.github/actions/validate-deployment-settings@vX
   with:
     settings-path: ./some/settings.json
     target: Supercomputer

.github/actions/validate-repo-version/README.md

@@ -20,7 +20,7 @@ This action checks that the tags specified in a models `config/versions.json` is
 ```yaml
 # ...
 - id: validate
-  uses: access-nri/build-cd/.github/actions/validate-repo-version@main
+  uses: access-nri/build-cd/.github/actions/validate-repo-version@vX
   with:
     repo-to-check: spack-packages
     pr: 12

.github/workflows/cd.yml

@@ -52,7 +52,7 @@ jobs:
 
       - name: Generate Deployment Target Matrix
         id: target
-        uses: access-nri/build-cd/.github/actions/get-target-matrix@v3
+        uses: access-nri/build-cd/.github/actions/get-target-matrix@v4
         with:
           targets: ${{ vars.RELEASE_DEPLOYMENT_TARGETS }}
 
@@ -65,12 +65,16 @@ jobs:
       matrix:
         target: ${{ fromJson(needs.defaults.outputs.targets) }}
     steps:
+      - name: Get default branch
+        id: default
+        run: echo "branch=$(gh repo view access-nri/build-cd --json defaultBranchRef --jq '.[].name')" >> $GITHUB_OUTPUT
+
       - uses: actions/checkout@v4
         with:
-          repository: ACCESS-NRI/build-cd
-          ref: main
+          repository: access-nri/build-cd
+          ref: ${{ steps.default.outputs.branch }}
 
-      - uses: access-nri/build-cd/.github/actions/validate-deployment-settings@main
+      - uses: access-nri/build-cd/.github/actions/validate-deployment-settings@v4
         with:
           settings-path: ./config/settings.json
           target: ${{ matrix.target }}
@@ -121,7 +125,7 @@ jobs:
     strategy:
       matrix:
         target: ${{ fromJson(needs.defaults.outputs.targets) }}
-    uses: access-nri/build-cd/.github/workflows/deploy-1-setup.yml@v3
+    uses: access-nri/build-cd/.github/workflows/deploy-1-setup.yml@v4
     with:
       deployment-target: ${{ matrix.target }}
       deployment-ref: ${{ github.ref_name }}
@@ -132,6 +136,9 @@ jobs:
     secrets: inherit
     permissions:
       contents: write
+      # We require pull-requests:write despite not using it in this path,
+      # because it is needed by the pull_request invocation of the workflow.
+      pull-requests: write
 
   release:
     name: Create Release
@@ -146,11 +153,15 @@ jobs:
       url: ${{ steps.release.outputs.url }}
       created-at: ${{ steps.metadata.outputs.created-at }}
     steps:
+      - name: Get default branch
+        id: default
+        run: echo "branch=$(gh repo view access-nri/build-cd --json defaultBranchRef --jq '.[].name')" >> $GITHUB_OUTPUT
+
       - name: Checkout build-cd
         uses: actions/checkout@v4
         with:
           repository: access-nri/build-cd
-          ref: v3
+          ref: ${{ steps.default.outputs.branch }}
 
       - name: Download Metadata Artifacts
         uses: actions/download-artifact@v4
@@ -214,6 +225,7 @@ jobs:
   build-db:
     name: Build DB Metadata Upload
     needs:
+      - defaults
       - deploy-release
       - release
     runs-on: ubuntu-latest
@@ -260,7 +272,7 @@ jobs:
             ${{ needs.release.outputs.url }} ${{ needs.release.outputs.created-at }} \
             ${{ steps.spack-versions.outputs.packages-version }} ${{ steps.spack-versions.outputs.config-version }} \
             ${{ env.METADATA_PATH }} ${{ env.OUTPUTS_PATH }} \
-            ${{ inputs.root-sbd }} ${{ vars.BUILD_DB_PACKAGES }}
+            ${{ needs.defaults.outputs.root-sbd }} ${{ vars.BUILD_DB_PACKAGES }}
 
           echo "Attempting upload of build_metadata.json"
           python ./tools/release_provenance/save_release.py "${{ env.OUTPUTS_PATH }}/build_metadata.json"

.github/workflows/ci-closed.yml

@@ -38,7 +38,7 @@ jobs:
 
       - name: Generate Deployment Target Matrix
         id: target
-        uses: access-nri/build-cd/.github/actions/get-target-matrix@v3
+        uses: access-nri/build-cd/.github/actions/get-target-matrix@v4
         with:
           targets: ${{ vars.PRERELEASE_DEPLOYMENT_TARGETS }}
 
@@ -50,7 +50,7 @@ jobs:
       matrix:
         target: ${{ fromJson(needs.setup.outputs.targets) }}
       fail-fast: false
-    uses: access-nri/build-cd/.github/workflows/undeploy-1-start.yml@main
+    uses: access-nri/build-cd/.github/workflows/undeploy-1-start.yml@v4
     with:
       version-pattern: ${{ inputs.root-sbd }}-pr${{ github.event.pull_request.number }}-*
       target: ${{ matrix.target }}

.github/workflows/ci.yml

@@ -125,7 +125,7 @@ jobs:
 
       - name: Generate Deployment Target Matrix
         id: target
-        uses: access-nri/build-cd/.github/actions/get-target-matrix@v3
+        uses: access-nri/build-cd/.github/actions/get-target-matrix@v4
         with:
           targets: ${{ vars.PRERELEASE_DEPLOYMENT_TARGETS }}
 
@@ -189,7 +189,7 @@ jobs:
       matrix:
         # Example: ['Gadi', 'Setonix', ...]
         target: ${{ fromJson(needs.defaults.outputs.targets) }}
-    uses: access-nri/build-cd/.github/workflows/deploy-1-setup.yml@main
+    uses: access-nri/build-cd/.github/workflows/deploy-1-setup.yml@v4
     with:
       deployment-target: ${{ matrix.target }}
       deployment-ref: ${{ needs.defaults.outputs.head-ref }}
@@ -245,11 +245,15 @@ jobs:
       OUTPUT_ARTIFACT_PATH: ./merged_outputs
       TEMPLATED_COMMENT_BODY_PATH: /opt/comment-body.md
     steps:
+      - name: Get default branch
+        id: default
+        run: echo "branch=$(gh repo view access-nri/build-cd --json defaultBranchRef --jq '.[].name')" >> $GITHUB_OUTPUT
+
       - name: Checkout build-cd for scripts
         uses: actions/checkout@v4
         with:
           repository: access-nri/build-cd
-          ref: v3
+          ref: ${{ steps.default.outputs.branch }}
 
       - name: Download matrix deployment outputs
         uses: actions/download-artifact@v4

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

@@ -1,5 +1,6 @@
 name: Deploy
 on:
+  # This is invoked by both `on.pull_request` and `on.push` events.
   workflow_call:
     inputs:
       deployment-target:
@@ -120,23 +121,27 @@ jobs:
 
       - name: Validate spack-packages version
         id: spack-packages
-        uses: access-nri/build-cd/.github/actions/validate-repo-version@main
+        uses: access-nri/build-cd/.github/actions/validate-repo-version@v4
         with:
           repo-to-check: spack-packages
           pr: ${{ inputs.deployment-ref }}
 
       - name: Validate spack version
         id: spack
-        uses: access-nri/build-cd/.github/actions/validate-repo-version@main
+        uses: access-nri/build-cd/.github/actions/validate-repo-version@v4
         with:
           repo-to-check: spack
           pr: ${{ inputs.deployment-ref }}
 
+      - name: Get default branch
+        id: default
+        run: echo "branch=$(gh repo view access-nri/build-cd --json defaultBranchRef --jq '.[].name')" >> $GITHUB_OUTPUT
+
       - name: Checkout build-cd Config
         uses: actions/checkout@v4
         with:
-          repository: ACCESS-NRI/build-cd
-          ref: main
+          repository: access-nri/build-cd
+          ref: ${{ steps.default.outputs.branch }}
           path: cd
 
       - name: Get spack-config version
@@ -151,7 +156,7 @@ jobs:
 
       - name: Validate build-cd config/settings.json
         id: settings
-        uses: access-nri/build-cd/.github/actions/validate-deployment-settings@main
+        uses: access-nri/build-cd/.github/actions/validate-deployment-settings@v4
         with:
           settings-path: ./cd/config/settings.json
           target: ${{ inputs.deployment-target }}
@@ -241,7 +246,7 @@ jobs:
             if [[ "$DEP" == "${{ inputs.spack-manifest-root-sbd }}" ]]; then
               # The model version is the bit after '@git.', before any later, space-separated, optional variants.
               # For example, in '[email protected] type=ACCESS ~debug' the version is 'VERSION'.
-              DEP_VER=$(yq '.spack.specs[0] | capture(".+@git\\.(?<version>[^ ]+).*") | .version' spack.yaml)
+              DEP_VER=$(yq '${{ env.SPACK_YAML_MODEL_YQ }} | capture(".+@git\\.(?<version>[^ ]+).*") | .version' spack.yaml)
             else
               # Capture the section after '@git.' or '@' (if it's not a git-attributed version) and before a possible '=' for a given dependency.
               # Ex. '@git.2024.02.11' -> '2024.02.11', '@access-esm1.5' -> 'access-esm1.5', '@git.2024.05.21=access-esm1.5' -> '2024.05.21'
@@ -280,14 +285,15 @@ jobs:
     needs:
       - check-config  # Verify configuration information is correct
       - check-spack-yaml  # Verify spack manifest information is correct
-    uses: access-nri/build-cd/.github/workflows/deploy-2-start.yml@v3
+    uses: access-nri/build-cd/.github/workflows/deploy-2-start.yml@v4
     with:
       type: ${{ inputs.deployment-type }}
       model: ${{ inputs.spack-manifest-root-sbd }}
       ref: ${{ inputs.deployment-ref }}
       version: ${{ inputs.deployment-version }}
       env-name: ${{ needs.check-spack-yaml.outputs.spack-env-name }}
-      deployment-environment: ${{ inputs.deployment-type == 'Prerelease' && format('{0} Prerelease', inputs.deployment-target) || inputs.deployment-target }}
+      deployment-target: ${{ inputs.deployment-target }}
+      deployment-type: ${{ inputs.deployment-type }}
       root-sbd: ${{ inputs.spack-manifest-root-sbd }}
     secrets: inherit
 

.github/workflows/deploy-2-start.yml

@@ -1,5 +1,5 @@
 name: Deploy Start
-concurrency: ${{ inputs.deployment-environment }}
+concurrency: ${{ inputs.deployment-target }} ${{ inputs.deployment-type }}
 on:
   workflow_call:
     inputs:
@@ -23,10 +23,19 @@ on:
         type: string
         required: true
         description: The spack-env-compliant environment name for the model
-      deployment-environment:
+      deployment-target:
         type: string
         required: true
-        description: The GitHub deployment environment name
+        description: |
+          The GitHub Environment, minus a potential Type.
+          Combined with inputs.deployment-type to create the GitHub Environment name.
+      deployment-type:
+        type: string
+        required: true
+        description: |
+          The type of deployment.
+          Can be one of: Release, Prerelease.
+          Combined with inputs.deployment-type to create the GitHub Environment name.
       root-sbd:
         type: string
         required: true
@@ -49,12 +58,12 @@ env:
   SPACK_YAML_MODEL_YQ: (.spack.definitions[] | select(."ROOT_PACKAGE") | .[][]) // .spack.specs[0]
   SPACK_YAML_MODULEFILE_PROJECTION_YQ: .spack.modules.default.tcl.projections.${{ inputs.root-sbd }}
   METADATA_PATH: /opt/metadata
-  ARTIFACT_NAME: deploy-metadata.${{ inputs.deployment-environment }}
+  ARTIFACT_NAME: deploy-metadata.${{ inputs.deployment-target }}
 jobs:
   deploy-to-environment:
-    name: Deploy to ${{ inputs.deployment-environment }}
+    name: Deploy to ${{ inputs.deployment-target }} ${{ inputs.deployment-type }}
     runs-on: ubuntu-latest
-    environment: ${{ inputs.deployment-environment }}
+    environment: ${{ inputs.deployment-target }} ${{ inputs.deployment-type != 'Release' && inputs.deployment-type || '' }}
     outputs:
       packages-version: ${{ steps.versions.outputs.packages }}
       config-version: ${{ steps.versions.outputs.config }}
@@ -73,13 +82,13 @@ jobs:
           echo "spack=$(jq --compact-output --raw-output '.spack' ./config/versions.json)" >> $GITHUB_OUTPUT
           echo "packages=$(jq --compact-output --raw-output '."spack-packages"' ./config/versions.json)" >> $GITHUB_OUTPUT
 
-      - name: Get ${{ inputs.deployment-environment }} Remote Paths
+      - name: Get ${{ inputs.deployment-target }} ${{ inputs.deployment-type }} Remote Paths
         id: path
-        uses: access-nri/build-cd/.github/actions/get-deploy-paths@main
+        uses: access-nri/build-cd/.github/actions/get-deploy-paths@v4
         with:
           spack-installs-root-path: ${{ vars.SPACK_INSTALLS_ROOT_LOCATION }}
           spack-version: ${{ steps.versions.outputs.spack }}
-          deployment-environment: ${{ inputs.deployment-environment }}
+          deployment-environment: ${{ inputs.deployment-target }} ${{ inputs.deployment-type }}
 
       - name: Setup SSH
         id: ssh
@@ -97,7 +106,7 @@ jobs:
         # Also removes the `@git.VERSION` specifier for Prereleases so
         # we don't have to shift tags around.
         run: |
-          yq -i '${{ env.SPACK_YAML_SPEC_YQ }} = (${{ env.SPACK_YAML_SPEC_YQ }} | split("@").[0])' spack.yaml
+          yq -i '${{ env.SPACK_YAML_MODEL_YQ }} = (${{ env.SPACK_YAML_MODEL_YQ }} | split("@").[0])' spack.yaml
           yq -i '${{ env.SPACK_YAML_MODULEFILE_PROJECTION_YQ }} = "{name}/${{ inputs.version }}"' spack.yaml
           echo '::notice::Prerelease accessible as module `${{ inputs.model}}/${{ inputs.version }}`'
 
@@ -125,16 +134,20 @@ jobs:
           done
           EOT
 
-      - name: Deploy to ${{ inputs.deployment-environment }}
+      - name: Deploy to ${{ inputs.deployment-target }} ${{ inputs.deployment-type }}
         # ssh into deployment environment, create and activate the env, install the spack.yaml.
         run: |
           ssh ${{ secrets.USER}}@${{ secrets.HOST }} -i ${{ steps.ssh.outputs.private-key-path }} /bin/bash <<'EOT'
           # Check that a suitable deployment location exists
           if [ ! -d "${{ steps.path.outputs.root }}" ]; then
-            echo '::error::A deployment of spack does not exist in `${{ steps.path.outputs.root }}` for `${{ inputs.deployment-environment }}`'
+            echo '::error::A deployment of spack does not exist in `${{ steps.path.outputs.root }}` for `${{ inputs.deployment-target }} ${{ inputs.deployment-type}}`'
             exit 1
           fi
 
+          # Export vars.DEPLOYMENT_TARGET
+          export DEPLOYMENT_TARGET="${{ vars.DEPLOYMENT_TARGET }}"
+          echo "DEPLOYMENT_TARGET exported as $DEPLOYMENT_TARGET"
+
           # Update spack-packages
           git -C ${{ steps.path.outputs.spack-packages }} fetch
           git -C ${{ steps.path.outputs.spack-packages }} checkout --force ${{ steps.versions.outputs.packages }}
@@ -156,11 +169,15 @@ jobs:
           echo "spack=${{ steps.path.outputs.spack }}" >> $GITHUB_OUTPUT
           echo "modules=${{ vars.DEPLOYED_MODULES_DIR }}" >> $GITHUB_OUTPUT
 
-      - name: Get metadata from ${{ inputs.deployment-environment }}
+      - name: Get metadata from ${{ inputs.deployment-target }} ${{ inputs.deployment-type}}
         env:
           SPACK_ENV_PATH: ${{ steps.path.outputs.spack }}/../environments/${{ inputs.env-name }}
         run: |
-          ssh ${{ secrets.USER}}@${{ secrets.HOST }} -i ${{ steps.ssh.outputs.private-key-path }} /bin/bash <<'EOT'
+          ssh ${{ secrets.USER }}@${{ secrets.HOST }} -i ${{ steps.ssh.outputs.private-key-path }} /bin/bash <<'EOT'
+          # Export vars.DEPLOYMENT_TARGET
+          export DEPLOYMENT_TARGET="${{ vars.DEPLOYMENT_TARGET }}"
+          echo "DEPLOYMENT_TARGET exported as $DEPLOYMENT_TARGET"
+
           . ${{ steps.path.outputs.spack-config }}/spack-enable.bash
           spack env activate ${{ inputs.env-name }}
 
@@ -213,7 +230,7 @@ jobs:
           # Rename the files to include the deployment environment
           cd ./${{ env.ARTIFACT_NAME }}
           for file in *; do
-            mv "$file" "${{ inputs.deployment-environment }}.$file"
+            mv "$file" "${{ inputs.deployment-target }}.$file"
           done
           cd -