-
Notifications
You must be signed in to change notification settings - Fork 128
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Recipe Test Workflow (RTW) prototype (#3210)
Co-authored-by: mo-tgeddes <[email protected]> Co-authored-by: Katherine Tomkins <[email protected]> Co-authored-by: Jon Lillis <[email protected]> Co-authored-by: Jon Lillis <[email protected]> Co-authored-by: Andrew Clark <[email protected]> Co-authored-by: Alistair Sellar <[email protected]> Co-authored-by: Alistair Sellar <[email protected]> Co-authored-by: Alistair Sellar <[email protected]> Co-authored-by: Ed <[email protected]> Co-authored-by: chrisbillowsMO <[email protected]> Co-authored-by: Valeriu Predoi <[email protected]> Co-authored-by: sloosvel <[email protected]>
- Loading branch information
13 people
authored
Nov 21, 2024
1 parent
e070fd5
commit dc23cdf
Showing
38 changed files
with
1,398 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| esmvaltool/cmorizers @ESMValGroup/obs-maintainers | ||
| .github/workflows @valeriupredoi | ||
| esmvaltool/utils/recipe_test_workflow/ @alistairsellar @ehogan |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| # This workflow performs various validation steps for Cylc and Rose. | ||
| name: Check Recipe Test Workflow (RTW) | ||
|
|
||
| # Controls when the action will run | ||
| on: | ||
| # Triggers the workflow on push events | ||
| push: | ||
| paths: | ||
| # - esmvaltool/utils/recipe_test_workflow/** | ||
|
|
||
| # Allows you to run this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
|
|
||
| # Common variables are defined here | ||
| env: | ||
| RTW_ROOT_DIR: esmvaltool/utils/recipe_test_workflow | ||
|
|
||
| # Required shell entrypoint to have properly configured bash shell | ||
| defaults: | ||
| run: | ||
| shell: bash -l {0} | ||
|
|
||
| # A workflow run is made up of one or more jobs that can run | ||
| # sequentially or in parallel | ||
| jobs: | ||
| # This workflow contains a single job called "check-rtw" | ||
| check-rtw: | ||
| # The type of runner that the job will run on | ||
| runs-on: ubuntu-latest | ||
|
|
||
| # Steps represent a sequence of tasks that will be executed as part | ||
| # of the job | ||
| steps: | ||
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job | ||
| # can access it | ||
| - uses: actions/checkout@v4 | ||
| - uses: conda-incubator/setup-miniconda@v3 | ||
| with: | ||
| miniforge-version: "latest" | ||
| miniforge-variant: Miniforge3 | ||
| use-mamba: true | ||
| conda-remove-defaults: "true" | ||
|
|
||
| - name: Install Cylc and Rose | ||
| run: conda install cylc-flow>=8.2 cylc-rose metomi-rose | ||
|
|
||
| - name: Check current environment | ||
| run: conda list | ||
|
|
||
| - name: Validate Cylc workflow | ||
| run: | | ||
| cd ${RTW_ROOT_DIR} | ||
| cylc validate . -O metoffice | ||
| - name: Run Cylc configuration linter | ||
| run: | | ||
| cd ${RTW_ROOT_DIR} | ||
| cylc lint | ||
| - name: Validate format of Rose configuration files | ||
| run: | | ||
| cd ${RTW_ROOT_DIR} | ||
| output="$(rose config-dump)" | ||
| msg="Run 'rose config-dump' to re-dump the Rose configuration files" | ||
| msg="${msg} in the common format, then commit the changes." | ||
| # The '-z' option returns true if 'output' is empty. | ||
| if [[ -z "${output}" ]]; then true; else echo "${msg}" && exit 1; fi | ||
| - name: Validate Rose configuration metadata | ||
| run: | | ||
| cd ${RTW_ROOT_DIR} | ||
| rose metadata-check -C meta/ | ||
| - name: Run Rose configuration validation macros | ||
| run: | | ||
| cd ${RTW_ROOT_DIR} | ||
| rose macro -V | ||
| - name: Lint shell scripts | ||
| run: | | ||
| cd ${RTW_ROOT_DIR} | ||
| output=$(find . -name "*.sh" -exec shellcheck {} \;) | ||
| if [ "$output" ]; then echo "${output}" && exit 1; fi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| ***** | ||
| About | ||
| ***** | ||
|
|
||
| .. include:: common.txt | ||
|
|
||
| The Recipe Test Workflow (|RTW|) is a workflow that is used to regularly run | ||
| recipes so issues can be discovered during the development process sooner | ||
| rather than later. | ||
|
|
||
| |Cylc| v8 and |Rose| v2 are used as the workflow engine and application | ||
| configuration system for the |RTW|, respectively. |Cylc| and |Rose| are not | ||
| included in the ESMValTool environment as they are typically already centrally | ||
| installed at sites e.g. JASMIN and the Met Office. |
Oops, something went wrong.