use ccache in GitHub actions #437
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
Reviewer's GuideConfigures ccache in multiple GitHub Actions workflows and wires it into CMake builds to cache compiler outputs and speed up CI builds on Linux, macOS, AppImage, and Wasm targets. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The ccache keys in the AppImage and Wasm workflows are just
${{ github.job }}, which means cache entries won’t vary by branch or significant build inputs; consider including something like${{ github.ref_name }}or a hash of key CMake files in the key (or restore-keys) to avoid suboptimal or incorrect cache reuse. - In
build-release.ymlandbuild-test.yml, the CMake*_LAUNCHER=ccachearguments are passed unconditionally even on Windows where ccache is not configured; you may want to guard those flags with the same OS condition as the ccache step or restrict them to non-Windows generators. - To make cache invalidation easier in the future, consider adding an explicit cache version segment (e.g.,
ccache-v1-...) to thekeyvalues so you can bump it without changing the rest of the key structure.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The ccache keys in the AppImage and Wasm workflows are just `${{ github.job }}`, which means cache entries won’t vary by branch or significant build inputs; consider including something like `${{ github.ref_name }}` or a hash of key CMake files in the key (or restore-keys) to avoid suboptimal or incorrect cache reuse.
- In `build-release.yml` and `build-test.yml`, the CMake `*_LAUNCHER=ccache` arguments are passed unconditionally even on Windows where ccache is not configured; you may want to guard those flags with the same OS condition as the ccache step or restrict them to non-Windows generators.
- To make cache invalidation easier in the future, consider adding an explicit cache version segment (e.g., `ccache-v1-...`) to the `key` values so you can bump it without changing the rest of the key structure.
## Individual Comments
### Comment 1
<location> `.github/workflows/build-release.yml:93` </location>
<code_context>
cd build
cmake --version
- cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -G 'Ninja' -DCPACK_PACKAGE_DIRECTORY=${{ github.workspace }}/artifact $MMAPPER_CMAKE_EXTRA -DWITH_WEBSOCKET=ON -DWITH_QTKEYCHAIN=ON -S .. || exit -1
+ cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -G 'Ninja' -DCPACK_PACKAGE_DIRECTORY=${{ github.workspace }}/artifact $MMAPPER_CMAKE_EXTRA -DWITH_WEBSOCKET=ON -DWITH_QTKEYCHAIN=ON -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -S .. || exit -1
cmake --build . --parallel
</code_context>
<issue_to_address>
**issue (bug_risk):** Guard the CMake ccache launcher flags to match the platforms where ccache is configured
These `-DCMAKE_*_COMPILER_LAUNCHER=ccache` flags are always set, but the ccache setup only runs on Linux/macOS. On Windows this will likely reference a non‑existent `ccache` binary and break configuration. Please gate these flags with the same `if: runner.os == 'Linux' || runner.os == 'macOS'` condition (e.g., via an env var or matrix flag) so they’re only applied where ccache is available.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| cd build | ||
| cmake --version | ||
| cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -G 'Ninja' -DCPACK_PACKAGE_DIRECTORY=${{ github.workspace }}/artifact $MMAPPER_CMAKE_EXTRA -DWITH_WEBSOCKET=ON -DWITH_QTKEYCHAIN=ON -S .. || exit -1 | ||
| cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -G 'Ninja' -DCPACK_PACKAGE_DIRECTORY=${{ github.workspace }}/artifact $MMAPPER_CMAKE_EXTRA -DWITH_WEBSOCKET=ON -DWITH_QTKEYCHAIN=ON -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -S .. || exit -1 |
There was a problem hiding this comment.
issue (bug_risk): Guard the CMake ccache launcher flags to match the platforms where ccache is configured
These -DCMAKE_*_COMPILER_LAUNCHER=ccache flags are always set, but the ccache setup only runs on Linux/macOS. On Windows this will likely reference a non‑existent ccache binary and break configuration. Please gate these flags with the same if: runner.os == 'Linux' || runner.os == 'macOS' condition (e.g., via an env var or matrix flag) so they’re only applied where ccache is available.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #437 +/- ##
==========================================
- Coverage 66.48% 65.48% -1.01%
==========================================
Files 85 86 +1
Lines 4186 3963 -223
Branches 255 264 +9
==========================================
- Hits 2783 2595 -188
+ Misses 1403 1368 -35 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary by Sourcery
Enable compiler caching in CI builds to speed up repeated compilations across workflows.
Build: