Skip to content

Commit 73ccd45

Browse files
asteriteTomAFrench
andauthored
feat: configurable external check failures (#6810)
Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
1 parent e341a3b commit 73ccd45

28 files changed

Lines changed: 77 additions & 4 deletions

File tree

.github/critical_libraries_status/AztecProtocol/aztec-packages/noir-projects/aztec-nr.failures.jsonl

Whitespace-only changes.

.github/critical_libraries_status/AztecProtocol/aztec-packages/noir-projects/noir-contracts.failures.jsonl

Whitespace-only changes.

.github/critical_libraries_status/AztecProtocol/aztec-packages/noir-projects/noir-protocol-circuits/crates/blob.failures.jsonl

Whitespace-only changes.

.github/critical_libraries_status/AztecProtocol/aztec-packages/noir-projects/noir-protocol-circuits/crates/parity-lib.failures.jsonl

Whitespace-only changes.

.github/critical_libraries_status/AztecProtocol/aztec-packages/noir-projects/noir-protocol-circuits/crates/private-kernel-lib.failures.jsonl

Whitespace-only changes.

.github/critical_libraries_status/AztecProtocol/aztec-packages/noir-projects/noir-protocol-circuits/crates/reset-kernel-lib.failures.jsonl

Whitespace-only changes.

.github/critical_libraries_status/AztecProtocol/aztec-packages/noir-projects/noir-protocol-circuits/crates/rollup-lib.failures.jsonl

Whitespace-only changes.

.github/critical_libraries_status/AztecProtocol/aztec-packages/noir-projects/noir-protocol-circuits/crates/types.failures.jsonl

Whitespace-only changes.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Critical Libraries Status
2+
3+
This directory contains one `.failures.jsonl` file per external directory that is checked by CI.
4+
CI will run the external repository tests and compare the test failures against those recorded
5+
in these files. If there's a difference, CI will fail.
6+
7+
This allows us to mark some tests as expected to fail if we introduce breaking changes.
8+
When tests are fixed on the external repository, CI will let us know that we need to remove
9+
the `.failures.jsonl` failures on our side.
10+
11+
The format of the `.failures.jsonl` files is one JSON per line with a failure:
12+
13+
```json
14+
{"suite":"one","name":"foo"}
15+
```
16+
17+
If it's expected that an external repository doesn't compile (because a PR introduces breaking changes
18+
to, say, the type system) you can remove the `.failures.jsonl` file for that repository and CI
19+
will pass again. Once the repository compiles again, CI will let us know and require us to put
20+
back the `.failures.jsonl` file.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{"event":"started","name":"one","test_count":1,"type":"suite"}
2+
{"event":"started","name":"foo","suite":"one","type":"test"}
3+
{"event":"failed","exec_time":0.05356625,"name":"foo","suite":"one","type":"test"}
4+
{"event":"ok","failed":0,"ignored":0,"passed":1,"type":"suite"}

0 commit comments

Comments
 (0)