Skip to content

ci: cache submodules#1081

Merged
alandtse merged 2 commits into
community-shaders:devfrom
alandtse:caching
May 19, 2025
Merged

ci: cache submodules#1081
alandtse merged 2 commits into
community-shaders:devfrom
alandtse:caching

Conversation

@alandtse
Copy link
Copy Markdown
Collaborator

@alandtse alandtse commented May 19, 2025

Summary by CodeRabbit

  • Chores
    • Updated build workflow to only run for changes affecting specific files and paths.
    • Builds for draft pull requests are now skipped unless manually triggered with a specific label.
    • Improved build cache handling to better track changes in certain files and directories.

alandtse added 2 commits May 18, 2025 20:28
A build can be forced with a label `force-build`.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 19, 2025

Walkthrough

The GitHub Actions build workflow was updated to limit the pull_request_target trigger to specific file types and paths, add conditions to skip builds for draft pull requests unless forced, and expand the build cache key to include .gitmodules and the extern directory for improved cache invalidation.

Changes

File(s) Change Summary
.github/workflows/build.yaml Updated workflow triggers to restrict pull_request_target to certain files; added job conditions to skip builds for draft PRs unless forced; expanded cache key to include .gitmodules and extern directory.

Poem

A workflow hops with nimble feet,
Skipping drafts, now extra neat!
Caches grow with modules new,
And extern paths are covered too.
Only the files that matter most
Will trigger builds—let’s raise a toast!
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/workflows/build.yaml (1)

30-33: Conditional to skip draft PR builds is correct
The if expression cleanly skips builds for draft PRs (unless labeled force-build) while still running on other events. Consider adding an inline comment for clarity, as this logic can be non-intuitive.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between a065923 and 060a8ee.

📒 Files selected for processing (1)
  • .github/workflows/build.yaml (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build plugin and addons
🔇 Additional comments (2)
.github/workflows/build.yaml (2)

53-53: Good addition of submodule and extern caching
Including .gitmodules and extern/** in the cache key ensures cache invalidation when submodules or external dependencies change. This aligns with the PR goal to cache submodules.


13-23: ⚠️ Potential issue

Ensure file path globs match all relevant files
The current patterns use **.cpp, **.h, etc., which may not match files in subdirectories (e.g., src/foo.cpp). For consistency—and to mirror the patterns in the cache key—use **/*.cpp, **/*.h, **/*.hpp, **/*.c, and **/CMakeLists.txt.

Apply this diff:

 pull_request_target:
-  paths:
-    - '**.cpp'
-    - '**.h'
-    - '**.hpp'
-    - '**.c'
-    - 'CMakeLists.txt'
+  paths:
+    - '**/*.cpp'
+    - '**/*.h'
+    - '**/*.hpp'
+    - '**/*.c'
+    - '**/CMakeLists.txt'
     - 'CMakePresets.json'
     - 'vcpkg.json'
     - 'vcpkg-configuration.json'
     - '.gitmodules'
     - 'extern/**'

Likely an incorrect or invalid review comment.

@github-actions
Copy link
Copy Markdown

✅ A pre-release build is available for this PR:
Download

@alandtse alandtse merged commit 645f312 into community-shaders:dev May 19, 2025
8 checks passed
alandtse added a commit to alandtse/open-shaders that referenced this pull request Jul 20, 2025
@alandtse alandtse deleted the caching branch December 24, 2025 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants