Skip to content

Add warning for spack-packages version compatibility #1064

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

Closed
aidanheerdegen wants to merge 2 commits into from
Closed

Add warning for spack-packages version compatibility #1064

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f91ceb6
Add warning for spack-packages version compatibility
aidanheerdegen Nov 11, 2025
4b54fe5
Add access-spack-packages warning to build source code page
aidanheerdegen Nov 13, 2025
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
7 changes: 5 additions & 2 deletions docs/models/build_a_model/build_source_code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ As an example, in the following instructions we will show how to modify [MOM5 co
!!! tip
The following instructions are valid (with simple tweaks) for all [ACCESS models].

## Prerequisites

- **NCI account**<br>
Before building a model, you need to [Set Up your NCI Account](/getting_started/set_up_nci_account).

Expand Down Expand Up @@ -127,6 +125,11 @@ spack concretize -f --reuse-deps
spack concretize -f --fresh
```

The version of [`access-nri/access-spack-packages`](https://github.com/ACCESS-NRI/access-spack-packages) must be compatible with the environment. If there are concretization errors try checking the version you cloned is the same as the version used in the deployment repository.
Copy link
Copy Markdown
Contributor

@anton-seaice anton-seaice Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The version of [`access-nri/access-spack-packages`](https://github.com/ACCESS-NRI/access-spack-packages) must be compatible with the environment. If there are concretization errors try checking the version you cloned is the same as the version used in the deployment repository.
!!! warning
The version of [`access-nri/access-spack-packages`](https://github.com/ACCESS-NRI/access-spack-packages) must be compatible with the environment. If there are concretization errors try checking the version you cloned is the same as the version used in the deployment repository.

Should this be a seperate warning? Its not very clear having two warnings in the same box

Can we be more explicit? How do i check the version ?


## Prerequisites


<terminal-window lineDelay=0>
<terminal-line data="input" lineDelay=200 directory="[mom5_dev]" class="spack">
spack concretize -f --reuse-deps
Expand Down
4 changes: 4 additions & 0 deletions docs/models/build_a_model/create_a_prerelease.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ For more information on the `spack.yaml` file, refer to [ACCESS-NRI's DevDocs](

The `config` directory contains a single `versions.json` file. This file allows customisation of both the version of [`access-nri/spack`](https://github.com/ACCESS-NRI/spack) used to deploy the model and the version of [`access-nri/spack-packages`](https://github.com/ACCESS-NRI/spack-packages) that will source the recipes for the _Spack_ packages.

!!! warning
It is important that the version of [`access-nri/spack-packages`](https://github.com/ACCESS-NRI/spack-packages) is compatible with the environment.
If there are concretization errors try checking this.

Comment on lines +57 to +60
Copy link
Copy Markdown
Contributor

@atteggiani atteggiani Nov 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indentation problem.

Suggested change
!!! warning
It is important that the version of [`access-nri/spack-packages`](https://github.com/ACCESS-NRI/spack-packages) is compatible with the environment.
If there are concretization errors try checking this.
!!! warning
It is important that the version of [`access-nri/spack-packages`](https://github.com/ACCESS-NRI/spack-packages) is compatible with the environment. If there are concretization errors try checking this.

What does "compatible" mean in this case? How would a user check that the spack-packages version is compatible with the spack environment?

Instead of saying "... try checking this", could we quickly describe how a user would check for such compatibility?

Copy link
Copy Markdown
Member Author

@aidanheerdegen aidanheerdegen Nov 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "compatible" mean in this case? How would a user check that the spack-packages version is compatible with the spack environment?

I was deliberately vague because there is no easy answer to your question. They might need to use the most recent version because then they get all the most recent spack package changes.

Or they might need to use an older version, because they need to remain consistent with the spack packages at an earlier time. There can be inter-dependency between the packages, where changes have to be made in sync so they are consistent.

Perhaps this is the right time to ask @anton-seaice if he had any specific use-cases in mind.

Instead of saying "... try checking this", could we quickly describe how a user would check for such compatibility?

I think the docs already cover where the spack packages version is set. Would it be sufficient to refer to that with a "see above" type direction? Other than that, to know what the "correct" version is depends on what they're trying to do. If it is to be consistent with a released version, then they should use what that environment did. If they're developing something new, then who knows? It would require some careful inspection of package recipes.

Copy link
Copy Markdown
Contributor

@anton-seaice anton-seaice Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps this is the right time to ask @anton-seaice if he had any specific use-cases in mind.

The main thing folks get stuck on is:

  • they clone spack-packages latest from main
  • checkout spack.yaml environment file from a deployment repo

and then find it doesn't concretise/build, becuase spack-packages has had a breaking change since the model was last deployed

Possibly if we are very careful with version dependencies going forward this won't continue to be a problem

## Trigger model prerelease and release build deployments

As mentioned above, prerelease build deployments are triggered by a push of one or more commits within a model deployment repository's open PR. When the PR is merged, a release build deployment is created.<br>
Expand Down
Loading