Skip to content

Commit af773aa

Browse files
committed
[GR-72552] Add Github CI contributor doc
PullRequest: graalpython/4193
2 parents fd6a588 + 2e92760 commit af773aa

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

docs/contributor/CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,26 @@ find graalpython -name '*.co' -delete
221221
mx punittest com.oracle.graal.python.test.compiler
222222
```
223223
224+
### CI Unittests
225+
226+
Most of our internal unittests are also ran on Github workflows.
227+
The `Run CI unittests` (`.github/workflows/ci-unittests.yml`) workflow will execute automatically when you open your PR, synchronize it and mark it as ready.
228+
**Note**: Unittests don't run on draft PRs.
229+
230+
By default, all gates defined in the `Run CI unittests` `jobs_to_run:` regex will run.
231+
You can run specific tests by manually triggering the `Generate CI Matrix from ci.jsonnet` (`.github/workflows/ci-matrix-gen.yml`) workflow and filling in the `Jobs to run` field.This field MUST be a valid python regex or be left empty to run all gates.
232+
233+
If you need to update any tags, please use the `Run Weekly unittest retagger` (`.github/workflows/ci-unittests-retagger.yml`) workflow. This sets up the required GitHub-specific environment and ensures that internal tests are not disrupted. Here again, you may use a Python regex to retag only specific platforms.
234+
235+
The retagger workflow will automatically open a ready-to-merge PR in your fork.
236+
237+
You can manually check which jobs will be run with your regex by using the `.github/scripts/extract_matrix.py` script.
238+
You will need to have the [sjsonnet](https://github.com/databricks/sjsonnet) binary available.
239+
240+
```bash
241+
python3 .github/scripts/extract_matrix.py ../sjsonnet ci.jsonnet tier{1-3} {regex} > matrix.json
242+
```
243+
224244
## Benchmarking
225245
226246
We use the `mx` facilities for benchmarking.

0 commit comments

Comments
 (0)