Shuffling and documenting prerequisites #5454
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
|
Not to overload this PR too much, but think moving to macos-14 or macos-15-intel would be needed since old one is getting deprecated, there are already changes needed added in #5434 but that one is on hold. For wheels I would keep what @donn added (so 15) but for compile and tests not sure, but looks like 15 is more available so better move to it. |
Contributor
|
yeah sorry i haven't had the time to get back to 5434 yet, will do when i can |
Member
Author
|
That was actually on my to-do list for today :) |
mmicko
approved these changes
Nov 4, 2025
Called during setup-build-env.
We still want to cache iverilog even if the rest of the action fails, so explicitly save/restore instead of standard cache.
Split into common + build/docs/test (common always installs, build/docs/test are installed as requested with `build-*-deps` input flag).
Add comments in setup-build-env/action.yml for where to document prereqs (and the separation between build/run and test). Add some initial (very basic) text for `test_suites.rst`, listing prereqs and how to run the tests (with subsections for the different optional tests, which is currently docs, functional and unit). Add sphinx-inline-tabs, use it for tidying up prereq instructions based on OS/platform (mostly helpful in the test suites doc where there are multiple sections split by OS). Also fixes some single backticks that should be double backtick.
Needed for vcd2fst.
mmicko
force-pushed
the
krys/cache-apt
branch
from
4e6f8bd to
35e4d96
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What are the reasons/motivation for this change?
While responding to a Discourse topic I remembered that I wanted to split the package dependencies to improve clarity and distinguish between requirements for building and testing (and to a lesser degree documenting). I also discovered the cache-apt-packages action, and while setting up the build environment isn't a huge overhead, it is done very frequently and so caching it seems reasonable. And iverilog was previously being installed/cached in two separate places, so we can reduce the redundancy there.
Explain how this is achieved.
setup-build-envactionsetup-build-env