add builder README.md and cleanup script #603
Merged
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.
This pull request improves the documentation and logic for the PerfSpect build system, with a focus on clarifying and optimizing the caching of external tool binaries. The main changes include a new, detailed README for the build system, simplification and clarification of the build script's cache logic, and an update to the GitHub Actions workflow to ensure cache invalidation works as intended.
Documentation improvements:
README.mdto thebuilder/directory, explaining the PerfSpect build process, caching mechanisms, and build artifacts, including detailed flow diagrams and environment variable explanations.Build script enhancements:
builder/build.shto clarify the use of the tools binary cache, including renaming variables for clarity (e.g.,USE_CACHE→USE_TOOLS_CACHE), and improving the logic that determines when to use cached binaries versus rebuilding from source.CI workflow update:
.github/workflows/build-test.ymlto hash all files in thetools/directory (tools/**), ensuring that any change to the tools triggers cache invalidation and a rebuild of the tools image.