Skip to content

Commit 0aae8e5

Browse files
authored
Update documentation related to reference tests (#4681)
Now that reference tests are available in release assets and we are no longer pushing tests to the consensus-spec-tests repo, we can remove documentation mentioning the consensus-spec-tests repo.
1 parent 7362239 commit 0aae8e5

5 files changed

Lines changed: 10 additions & 23 deletions

File tree

.gitignore

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ build/
1111
output/
1212
dist/
1313

14-
consensus-spec-tests/
15-
1614
.pytest_cache
1715
.mypy_cache
1816

@@ -25,10 +23,7 @@ tests/core/pyspec/eth2spec/deneb/
2523
tests/core/pyspec/eth2spec/electra/
2624
tests/core/pyspec/eth2spec/fulu/
2725
tests/core/pyspec/eth2spec/gloas/
28-
tests/core/pyspec/eth2spec/eip6800/
29-
tests/core/pyspec/eth2spec/eip7441/
30-
tests/core/pyspec/eth2spec/eip7805/
31-
tests/core/pyspec/eth2spec/eip7928/
26+
tests/core/pyspec/eth2spec/eip*/
3227

3328
# coverage reports
3429
.htmlcov

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ TEST_REPORT_DIR = $(PYSPEC_DIR)/test-reports
225225

226226
# Run pyspec tests.
227227
test: MAYBE_TEST := $(if $(k),-k=$(k))
228-
# Disable parallelism which running a specific test.
228+
# Disable parallelism when running a specific test.
229229
# Parallelism makes debugging difficult (print doesn't work).
230230
test: MAYBE_PARALLEL := $(if $(k),,-n auto)
231231
test: MAYBE_FORK := $(if $(fork),--fork=$(fork))

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,9 @@ functionality can be found in the following repositories:
5252

5353
### Reference tests
5454

55-
Reference tests built from the executable Python spec are available in the
56-
[Ethereum Proof-of-Stake Consensus Spec Tests](https://github.com/ethereum/consensus-spec-tests)
57-
repository. Compressed tarballs are available for each release
58-
[here](https://github.com/ethereum/consensus-spec-tests/releases). Nightly
59-
reference tests are available
55+
Reference tests built from the executable Python specifications are available in
56+
the release assets for each release in this repository. There are also *nightly*
57+
reference tests which are built from the latest version of the specifications
6058
[here](https://github.com/ethereum/consensus-specs/actions/workflows/generate_vectors.yml).
6159

6260
## Contributors

docs/docs/release.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ git tag <version>
4343
git push origin <version>
4444
```
4545

46-
Approximately 12 hours later, the releases for consensus-specs and
47-
consensus-spec-tests will be available on GitHub.
46+
Several hours later, the consensus-specs release will be automatically published
47+
on GitHub.
4848

4949
## Make an Announcement
5050

@@ -62,6 +62,4 @@ Use the following template for your announcement:
6262
Consensus layer specs <version> -- <release-name> -- released!
6363

6464
https://github.com/ethereum/consensus-specs/releases/tag/<version>
65-
66-
Test vectors: https://github.com/ethereum/consensus-spec-tests/releases/tag/<version>
6765
```

tests/README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -447,13 +447,9 @@ ignore it)
447447
448448
So far we've ran tests against the formal specifications. This is a way to check
449449
the specifications are what we expect, but it doesn't actually check the beacon
450-
chain clients. The way these tests get applied by clients is that every few
451-
weeks
452-
[new test specifications are released](https://github.com/ethereum/consensus-spec-tests/releases),
453-
in a format
454-
[documented here](https://github.com/ethereum/consensus-specs/tree/master/tests/formats).
455-
All the consensus layer clients implement test-runners that consume the test
456-
vectors in this standard format.
450+
chain clients. Consensus layer clients implement test-runners that
451+
consume/execute these reference tests to ensure they have implemented the
452+
specifications properly.
457453
458454
______________________________________________________________________
459455

0 commit comments

Comments
 (0)