Add access-spack-packages ref to final manifest rather than in the install step

Author: CodeGat

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

@@ -145,6 +145,13 @@ jobs:
             --packages "${{ steps.config-packages.outputs.packages-for-injection }}" \
             --output ../${{ inputs.spack-manifest-path }}
 
+      - name: Get SHA for access-spack-packages repository
+        id: packages-ref
+        uses: access-nri/actions/.github/actions/get-git-ref-info@main
+        with:
+          repository: ACCESS-NRI/access-spack-packages
+          ref: ${{ steps.versions.outputs.packages }}
+
       - name: Spack Manifest - Prerelease Injection
         if: inputs.deployment-type == 'Prerelease'
         # Modifies the name of the prerelease modulefile to the pr<number>-<deployment number>` style.
@@ -156,6 +163,7 @@ jobs:
             --manifest ../${{ inputs.spack-manifest-path }} \
             --version ${{ inputs.version }} \
             --spack-packages-path ${{ steps.path.outputs.spack-environment }}/access-spack-packages \
+            --spack-packages-version-sha ${{ steps.packages-ref.outputs.sha }} \
             ${{ steps.modules-injection.outputs.custom-projection != '' && format('--custom-root-projection {0}', steps.modules-injection.outputs.custom-projection ) || ''}} \
             --output ../${{ inputs.spack-manifest-path }}
 
@@ -183,13 +191,6 @@ jobs:
           done
           EOT
 
-      - name: Get SHA for access-spack-packages repository
-        id: packages-ref
-        uses: access-nri/actions/.github/actions/get-git-ref-info@main
-        with:
-          repository: ACCESS-NRI/access-spack-packages
-          ref: ${{ steps.versions.outputs.packages }}
-
       - name: Deploy to ${{ inputs.deployment-target }} ${{ inputs.deployment-type }}
         id: deploy
         # ssh into deployment environment, create and activate the env, install the spack manifest.
@@ -211,9 +212,6 @@ jobs:
           # Create and activate environment
           spack env activate ${{ inputs.env-name }} --create --envfile ${{ vars.SPACK_YAML_LOCATION }}/${{ inputs.expected-root-spec-name }}-${{ github.run_id }}.spack.yaml
 
-          # Update access-spack-packages repository before installation
-          spack repo update access_spack_packages --commit ${{ steps.packages-ref.outputs.sha }}
-
           # Finally, install the spack manifest
           spack --debug install --fail-fast --fresh ${{ vars.SPACK_INSTALL_ADDITIONAL_ARGS }} || exit $?
           spack module tcl refresh -y

scripts/spack_manifest/injection/prerelease.py

@@ -39,6 +39,7 @@ def inject_prerelease_information(
     custom_root_projection: str | None = None,
     keep_root_spec_intact: bool = False,
     spack_packages_path: str | None = None,
+    spack_packages_version_sha: str | None = None,
 ) -> str:
     # In comparison to the projections script, this returns a string rather than a dict because we need to
     # add spack-specific, non-standard 'repo::' sections, which the yaml dumper does not support.
@@ -69,7 +70,7 @@ def inject_prerelease_information(
     if spack_packages_path:
         # Add the 'repo:' section for prerelease spack packages if provided
         updated_manifest = add_prerelease_repos_section(
-            updated_manifest, spack_packages_path
+            updated_manifest, spack_packages_path, spack_packages_version_sha
         )
 
     # Dump the current dict, and add the non-standard 'repo::' section
@@ -151,7 +152,7 @@ def update_root_spec_projection_version(
 
 
 def add_prerelease_repos_section(
-    manifest: dict[str, Any], spack_packages_path: str
+    manifest: dict[str, Any], spack_packages_path: str, spack_packages_version_sha: str | None = None
 ) -> dict[str, Any]:
 
     manifest.setdefault("spack", {}).setdefault("repos", {})
@@ -162,6 +163,9 @@ def add_prerelease_repos_section(
         }
     }
 
+    if spack_packages_version_sha:
+        manifest["spack"]["repos"]["access_spack_packages"]["commit"] = spack_packages_version_sha
+
     return manifest
 
 
@@ -208,6 +212,13 @@ def parse_args(args: list[str]) -> argparse.Namespace:
         help="Local path to a spack-packages repository that is added to the manifests repos section",
     )
 
+    parser.add_argument(
+        "--spack-packages-version-sha",
+        type=str,
+        required=False,
+        help="Git SHA of the spack-packages repository that is added to the manifests repos section",
+    )
+
     # Args dealing with outputs
     parser.add_argument(
         "--output",
@@ -228,6 +239,7 @@ def main():
         args.custom_root_projection,
         args.keep_root_spec_intact,
         args.spack_packages_path,
+        args.spack_packages_version_sha,
     )
 
     print(injected_manifest)

tests/scripts/spack_manifest/injection/outputs/expected.prerelease.spack.yaml

@@ -49,3 +49,4 @@ spack:
     access_spack_packages:
       git: https://github.com/ACCESS-NRI/access-spack-packages.git
       destination: /some/spack-packages
+      commit: e8713551c6eee57caf9603543e6dd6daf3c93922

tests/scripts/spack_manifest/injection/test_prerelease.py

@@ -149,9 +149,10 @@ def test_inject_prerelease_information__valid_custom_projection(self):
         root_spec_version = "pr12-12"
         custom_root_projection = "2024.03.0"
         spack_packages_path = "/some/spack-packages"
+        spack_packages_version_sha = "e8713551c6eee57caf9603543e6dd6daf3c93922"
 
         updated_manifest_str: str = inject_prerelease_information(
-            manifest_path, root_spec_version, custom_root_projection, False, spack_packages_path
+            manifest_path, root_spec_version, custom_root_projection, spack_packages_path, spack_packages_version_sha
         )
 
         expected_manifest_path = "tests/scripts/spack_manifest/injection/outputs/expected.prerelease.spack.yaml"