Add hint for solving CLI tests failure (#5041)

* Add hint for solving CLI test failure.

* Add `make cli-local`
This commit is contained in:
Paul Hauner 2024-01-09 02:30:37 +11:00 committed by GitHub
parent db05d37675
commit f62cfc6475
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 3 deletions

View File

@ -200,12 +200,17 @@ test-exec-engine:
# test vectors.
test: test-release
# Updates the CLI help text pages in the Lighthouse book.
# Updates the CLI help text pages in the Lighthouse book, building with Docker.
cli:
docker run --rm --user=root \
-v ${PWD}:/home/runner/actions-runner/lighthouse sigmaprime/github-runner \
bash -c 'cd lighthouse && make && ./scripts/cli.sh'
# Updates the CLI help text pages in the Lighthouse book, building using local
# `cargo`.
cli-local:
make && ./scripts/cli.sh
# Runs the entire test suite, downloading test vectors if required.
test-full: cargo-fmt test-release test-debug test-ef test-exec-engine

View File

@ -2,7 +2,7 @@
# IMPORTANT
# This script should NOT be run directly.
# Run `make cli` from the root of the repository instead.
# Run `make cli` or `make cli-local` from the root of the repository instead.
set -e
@ -90,7 +90,7 @@ rm -f help_general.md help_bn.md help_vc.md help_am.md help_vm.md help_vm_create
# only exit at the very end
if [[ $changes == true ]]; then
echo "Exiting with error to indicate changes occurred..."
echo "Exiting with error to indicate changes occurred. To fix, run `make cli-local` or `make cli` and commit the changes."
exit 1
else
echo "CLI help texts are up to date."