Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs,ci): add build-evm-base to docs deploy workflows #829

Merged
merged 1 commit into from
Sep 23, 2024

Conversation

danceratopz
Copy link
Member

@danceratopz danceratopz commented Sep 23, 2024

πŸ—’οΈ Description

#792 would also fix this; we can disregard this PR if #792 gets merged first/quickly

#801 re-implements the "Test Case Reference" generation script as a pytest plugin (based on top of fill). As the forks plugin (and others; didn't check) require a t8n tool in the path, we need to provide one, even if it's not strictly necessary to build docs.

This is a tricky subject. I'm not a fan of requiring a t8n tool to collect tests/build doc, but if we use t8n properties in test markers or other places, it's not easy to avoid.

πŸ”— Related Issues

#801

βœ… Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.
  • All: Added an entry to CHANGELOG.md. Skipped
  • All: Considered updating the online docs in the ./docs/ directory.
  • Tests: All converted JSON/YML tests from ethereum/tests have been added to converted-ethereum-tests.txt.
  • Tests: A PR with removal of converted JSON/YML tests from ethereum/tests have been opened.
  • Tests: Included the type and version of evm t8n tool used to locally execute test cases: e.g., ref with commit hash or geth 1.13.1-stable-3f40e65.
  • Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

@danceratopz danceratopz added type:bug Something isn't working scope:docs Scope: Documentation scope:ci Scope: Continuous Integration labels Sep 23, 2024
Copy link
Member

@marioevz marioevz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I think we might need to abstract away the evm-bin part in the plugins, it should be possible to remove this requirement.

@marioevz marioevz merged commit 172e6bb into main Sep 23, 2024
7 checks passed
@marioevz marioevz deleted the fix/docs/add-t8n-tool-to-deploy-workflow branch September 23, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:ci Scope: Continuous Integration scope:docs Scope: Documentation type:bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants