Added undeploy-*.yml workflows for removing deployments

Author: CodeGat

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

@@ -0,0 +1,55 @@
+name: Undeployment Setup
+on:
+  workflow_call:
+    inputs:
+      version:
+        type: string
+        required: true
+        description: The version of the model being removed
+jobs:
+  get-spack-env:
+    name: Get Spack Environment
+    runs-on: ubuntu-latest
+    outputs:
+      model: ${{ steps.get-model.outputs.model }}
+      env-name: ${{ steps.get-env-name.outputs.env-name }}
+    steps:
+      - name: Get Model
+        id: get-model
+        # for the cases where the repo name is in uppercase but the package name is lowercase (eg. access-nri/MOM5)
+        run: echo "model=$(echo ${{ github.event.repository.name }} | tr [:upper:] [:lower:])" >> $GITHUB_OUTPUT
+      - name: Set Spack Env Name String
+        id: get-env-name
+        # 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
+
+  get-prerelease-deployment-env:
+    name: Get Prerelease Deployment Environment
+    runs-on: ubuntu-latest
+    outputs:
+      deployment-environments: ${{ steps.get-deployment-environment.outputs.deployment-environments }}
+    steps:
+      - name: Checkout Config
+        uses: actions/checkout@v4
+        with:
+          repository: access-nri/build-cd
+
+      - name: Get Environments
+        id: get-deployment-environment
+        run: echo "deployment-environments=$(jq --compact-output '.prerelease-environments' ./config/deployment-environment.json)" >> $GITHUB_OUTPUT
+
+
+  deployment:
+    name: Deployment
+    needs:
+      - get-spack-env
+      - get-prerelease-deployment-env
+    strategy:
+      fail-fast: false
+      matrix:
+        deployment-environment: ${{ fromJson(needs.get-prerelease-deployment-env.outputs.deployment-environments) }}
+    uses: access-nri/build-cd/.github/workflows/undeploy-2-start.yml@main
+    with:
+      deployment-environment: ${{ matrix.deployment-environment }}
+      env-name: ${{ needs.get-spack-env.outputs.env-name }}
+    secrets: inherit

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

@@ -0,0 +1,51 @@
+name: Undeployment Start
+on:
+  workflow_call:
+    inputs:
+      env-name:
+        type: string
+        required: true
+        description: The spack-env-compliant model name to remove
+      deployment-environment:
+        type: string
+        required: true
+        description: The GitHub deployment environment name
+jobs:
+  undeploy-from-environment:
+    name: Undeploy ${{ inputs.env-name }} from ${{ inputs.deployment-environment }}
+    runs-on: ubuntu-latest
+    environment: ${{ inputs.deployment-environment }}
+    steps:
+      - name: Setup SSH
+        id: ssh
+        uses: access-nri/actions/.github/actions/setup-ssh@main
+        with:
+          private-key: ${{ secrets.SSH_KEY }}
+          hosts: |
+            ${{ secrets.HOST }}
+            ${{ secrets.HOST_DATA }}
+
+      - name: Undeploy
+        # ssh into deployment environment, create and activate the env, remove all the unneeded environments
+        id: undeploy
+        run: |
+          ssh ${{ secrets.USER}}@${{ secrets.HOST }} -i ${{ steps.ssh.outputs.private-key-path }} /bin/bash <<'EOT'
+          . ${{ vars.SPACK_CONFIG_LOCATION }}/spack-enable.bash
+          envs=$(find ${{ vars.SPACK_LOCATION }}/var/spack/environments -type d -name '${{ inputs.env-name }}' -printf '%f ')
+
+          for env in $envs; do
+            spack env activate $env
+            spack uninstall --remove --dependents --yes-to-all --all
+            spack env rm $env --yes-to-all
+          done
+          spack gc --yes-to-all
+          EOT
+
+      - name: Undeploy Status Notifier
+        if: always()
+        run: |
+          if [[ "${{ steps.undeploy.outcome }}" == "success" ]]; then
+            echo "::notice::Deployment ${{ inputs.env-name }} was successfully removed from ${{ inputs.deployment-environment }}"
+          else
+            echo "::error::Deployment ${{ inputs.env-name }} couldn't be removed from ${{ inputs.deployment-environment}}. Please check manually."
+          fi