Speed up test data caching in CI #566
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
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #566 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 28 28
Lines 1571 1571
=========================================
Hits 1571 1571 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
adamltyson
approved these changes
May 1, 2025
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
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.
Description
What is this PR
Why is this PR needed?
We've noticed for a long time that the Windows runner in CI takes significantly longer than other runners. I suspect it's related to the cross-OS cache not working as intended, likely due to
~resolving to a different absolute path depending on OS, see https://github.com/actions/cache/blob/main/tips-and-workarounds.md#cross-os-cache.Moreover, I noticed a significant slowdown in the
build_sphinx_docsaction run times, manifest since we started using videos in some of the examples. They get downloaded each time because we hadn't previously implemented caching for that action.What does this PR do?
brainglobe-workflows: OS specific caches brainglobe/brainglobe-workflows#142build_sphinx_docsaction, since that has also slowed down since we added videos to some of the examples (e.g. pupil tracking). We shouldn't have to download these each time.References
brainglobe/brainglobe-workflows#142
How has this PR been tested?
I manually ran CI several times in this PR, to observe run times, and it seems to work.
First Windows test runs were 23-32 minutes, and subsequent ones were 9-10 minutes (after windows-specific cache was populated). Similarly the
build_sphinx_docsrun times went from ~9 to ~2-3 minutes.No jobs takes >10 minutes now!
Is this a breaking change?
No.
Does this PR require an update to the documentation?
No.
Checklist: