Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: jo-basevi <johanna.basevi@anu.edu.au>
  • Loading branch information
CodeGat and jo-basevi authored Jun 18, 2024
1 parent 959f357 commit 66738d8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README-DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ This dispatchable workflow allows developers to generate and commit initial chec

This is the `config/ci.json` configuration file for specifying different test markers, or test versions based on type of the test to run, and the name of the git branch or tag. The different types of test are defined as:

- `scheduled`: These are scheduled monthly reproducibility tests that are run as part of [`schedule-2-start.yml`](#scheduled). The keys under these tests represent released config tags to run scheduled checks on.
- `reproducibility`: These are reproducibility tests are run as part of [`pr-1-ci.yml`](#pull-request). The keys under these tests represent the target branches into which pull requests are being merged.
- `qa` - These are quick QA tests are run as part of [`pr-1-ci.yml`](#pull-request). The keys under these tests represent the target branches into which pull requests are being merged.
- `scheduled`: Scheduled monthly reproducibility tests. The keys under these tests represent released config tags to run scheduled checks on.
- `reproducibility`: Reproducibility tests that are run as part of pull requests. The keys under these tests represent the target branches into which pull requests are being merged.
- `qa` - Quick quality assurance tests that are run as part of pull requests. The keys under these tests represent the target branches into which pull requests are being merged.

The configuration properties needed to run the tests are:

Expand All @@ -38,6 +38,6 @@ The configuration properties needed to run the tests are:
| model-config-tests-version | `string` | The version of the model-config-tests | `0.0.1` |
| python-version | `string` | The python version used to create test virtual environment | `3.11.0` |

As most of the tests use the same test and python versions, and similar markers, there are two levels of defaults. There's a default at test type level which is useful for defining test markers - this selects certain pytests to run in `model-config-tests`. There is an outer global default, which is used if a property is not defined for a given branch/tag, and it is not defined for the test default. The `parse-ci-config` action applies the fall-back default logic. For more information on using this action see [`parse-ci-config` README.md](./.github/actions/parse-ci-config/README.md).
As most of the tests use the same test and python versions, and similar markers, there are two levels of defaults. There's a default at test type level which is useful for defining test markers - this selects certain pytests to run in `model-config-tests`. There is an outer global default, which is used if a property is not defined for a given branch/tag, and it is not defined for the test default. The `parse-ci-config` action applies the fall-back default logic. For more information on using this action see [`ACCESS-NRI/model-config-tests`](https://github.com/ACCESS-NRI/model-config-tests/).

The CI for this file (in [`config.yml`](./.github/workflows/config.yml)) validates modifications to the `ci.json` against it's schema, found in [`ACCESS-NRI/schema`](https://github.com/ACCESS-NRI/schema). It does not yet verify that modifications make sense.

0 comments on commit 66738d8

Please sign in to comment.