Skip to content

Commit 4a68365

Browse files
committed
Add options to README.md
1 parent f4307ac commit 4a68365

2 files changed

Lines changed: 15 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ jobs:
4141
steps:
4242
- uses: actions/checkout@v6
4343
- uses: eessi/github-action-eessi@v3
44+
with:
45+
eessi_stack_version: '2025.06'
4446
- name: Test EESSI
4547
run: |
4648
module avail
@@ -65,7 +67,10 @@ jobs:
6567
## Optional Parameters
6668
The following parameters are supported:
6769
- `eessi_stack_version`: version of the EESSI stack to use (defaults to `2023.06`)
68-
- `eessi_config_package`: location of the EESSI CernVM-FS configuration package (defaults to `https://github.com/EESSI/filesystem-layer/releases/download/latest/cvmfs-config-eessi_latest_all.deb`).
70+
- `eessi_repositories`: Comma separated list of EESSI repositories to make available (defaults to `software.eessi.io,dev.eessi.io`).
71+
- `use_eessi_module`: Use the Lmod method to initialise EESSI (defaults to `true`)
72+
- `mount_cvmfs_only`: Only mount the EESSI CernVM-FS repositories, do not initialise EESSI (defaults to `false`)
73+
- `init_direnv`: Initialise direnv for the repository (defaults to `true`)
6974
<!--For macOS this parameter is required (e.g., `https://github.com/EESSI/filesystem-layer/releases/download/latest/cvmfs-config-eessi_latest_all.pkg`) -->
7075

7176
## Minimal Example

action.yml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,19 @@ runs:
3535
cvmfs_http_proxy: DIRECT
3636
cvmfs_repositories: 'cvmfs-config.cern.ch,${{ inputs.eessi_repositories }}'
3737
- id: install-eessi
38+
shell: bash
39+
env:
40+
EESSI_STACK_VERSION: ${{ inputs.eessi_stack_version }}
41+
ALLOWED_VERSIONS: "2023.06 2025.06"
3842
run: |
3943
if [ "$RUNNER_OS" == "Linux" ]; then
4044
echo 'unset BASH_ENV' >> $HOME/env_config.export
4145
if [[ "${{ inputs.mount_cvmfs_only }}" == "false" ]]; then
46+
[[ " $ALLOWED_VERSIONS " =~ " $EESSI_STACK_VERSION " ]] || {
47+
echo "Invalid eessi_stack_version: '$EESSI_STACK_VERSION'"
48+
echo "Allowed values: $ALLOWED_VERSIONS"
49+
exit 1
50+
}
4251
if [[ "${{ inputs.use_eessi_module }}" == "true" ]]; then
4352
# Make the EESSI module sticky so that it persists in case `module purge` is used
4453
# (while still allowing for a swap if needed)
@@ -72,6 +81,3 @@ runs:
7281
# cat /Users/runner/.lima/eessi/ha.stderr.log
7382
fi
7483
shell: bash
75-
env:
76-
EESSI_STACK_VERSION: ${{ inputs.eessi_stack_version }}
77-

0 commit comments

Comments
 (0)