Skip to content

Add sccache to setup-rust#28

Merged
leynos merged 6 commits intomainfrom
codex/add-sccache-to-setup-rust-action
Jul 24, 2025
Merged

Add sccache to setup-rust#28
leynos merged 6 commits intomainfrom
codex/add-sccache-to-setup-rust-action

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 22, 2025

Summary

  • enable sccache for faster incremental builds in the setup-rust action
  • document the new sccache behaviour
  • record the change in the action changelog

Testing

  • ruff check .
  • pytest -q

https://chatgpt.com/codex/tasks/task_e_687f35a3e1d08322835191abfd98c8c0

Summary by Sourcery

Enable sccache caching in the setup-rust GitHub Action for non-release workflows and update the documentation and changelog accordingly.

New Features:

  • Integrate mozilla-actions/sccache-action for non-release runs in the setup-rust action
  • Set SCCACHE_GHA_ENABLED and RUSTC_WRAPPER environment variables to use sccache

Documentation:

  • Add section to README explaining sccache usage and environment variables on non-release events

Chores:

  • Add v1.0.5 entry to CHANGELOG for sccache integration

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 22, 2025

Reviewer's Guide

This PR integrates Mozilla’s sccache into the setup-rust GitHub Action for non-release workflows by adding conditional steps and environment variables in the action definition, and updates the documentation and changelog accordingly.

Flow diagram for conditional sccache usage in setup-rust

flowchart TD
    Start([Start Workflow])
    CheckEvent{Is event 'release'?}
    RunSccache[Run sccache-action]
    SetEnv[Set SCCACHE_GHA_ENABLED and RUSTC_WRAPPER]
    Continue[Continue with build steps]

    Start --> CheckEvent
    CheckEvent -- No --> RunSccache
    RunSccache --> SetEnv
    SetEnv --> Continue
    CheckEvent -- Yes --> Continue
Loading

File-Level Changes

Change Details Files
Integrate sccache into the action for non-release runs
  • Add a step to invoke mozilla-actions/sccache-action@v0.0.9
  • Add a step to export SCCACHE_GHA_ENABLED and RUSTC_WRAPPER when not on release events
.github/actions/setup-rust/action.yml
Document sccache behavior in the README
  • Add a section explaining non-release runs trigger sccache
  • Describe the new environment variables and benefits
.github/actions/setup-rust/README.md
Record sccache integration in the changelog
  • Create a new v1.0.5 entry
  • Note sccache integration on non-release runs
.github/actions/setup-rust/CHANGELOG.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 22, 2025

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 22 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 5164d5e and f8b138f.

📒 Files selected for processing (1)
  • .github/actions/setup-rust/README.md (3 hunks)

Summary by CodeRabbit

  • Documentation

    • Updated documentation to describe new input parameters for enabling and configuring build caching.
    • Added details on caching behaviour and new environment variables.
  • New Features

    • Introduced options to enable or disable build caching for non-release runs and specify the caching action version.
  • Style

    • Adjusted default values for certain input parameters to improve consistency.

Walkthrough

Document the integration of sccache into the Rust setup GitHub Action for non-release workflows. Update the changelog, README, and action configuration to reflect the new caching mechanism, including setting relevant environment variables and ensuring these steps are conditionally applied outside of release events.

Changes

File(s) Change Summary
.github/actions/setup-rust/CHANGELOG.md Add changelog entry for v1.0.5 detailing sccache integration for non-release runs.
.github/actions/setup-rust/README.md Update documentation to describe new use-sccache and sccache-action-version inputs and caching behaviour.
.github/actions/setup-rust/action.yml Add inputs use-sccache and sccache-action-version; insert conditional steps to run sccache action and set env vars.

Sequence Diagram(s)

sequenceDiagram
    participant GitHub Actions
    participant Setup Rust Action
    participant sccache Action

    GitHub Actions->>Setup Rust Action: Trigger workflow
    alt Not a release event and use-sccache enabled
        Setup Rust Action->>sccache Action: Run sccache setup
        Setup Rust Action->>Setup Rust Action: Set SCCACHE_GHA_ENABLED and RUSTC_WRAPPER env vars
    end
    Setup Rust Action->>Setup Rust Action: Continue with system dependency installation
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

  • Pin nightly toolchain mxd#139: Introduces the initial setup-rust action and pins the Rust toolchain, which is now enhanced by this PR's caching improvements.

Poem

Rust builds fly on caching wings,
With sccache now in the flow,
Release events skip these things,
For all else, speed will grow.
🦀⚡

Code runs faster, spirits high—
Let the compilers sigh!

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/add-sccache-to-setup-rust-action

🪧 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 generate unit tests to generate unit tests for 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

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @leynos - I've reviewed your changes - here's some feedback:

  • Consider exposing sccache as an optional action input instead of hardcoding it for non-release runs to give users more control.
  • You may want to cache sccache’s internal directory (e.g. $HOME/.cache/sccache) between workflow runs to improve hit rates.
  • Make the mozilla-actions/sccache-action version configurable or bump to the latest release to ease future maintenance.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider exposing sccache as an optional action input instead of hardcoding it for non-release runs to give users more control.
- You may want to cache sccache’s internal directory (e.g. $HOME/.cache/sccache) between workflow runs to improve hit rates.
- Make the mozilla-actions/sccache-action version configurable or bump to the latest release to ease future maintenance.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 688ce00 and 76be518.

📒 Files selected for processing (3)
  • .github/actions/setup-rust/CHANGELOG.md (1 hunks)
  • .github/actions/setup-rust/README.md (1 hunks)
  • .github/actions/setup-rust/action.yml (1 hunks)
🔇 Additional comments (1)
.github/actions/setup-rust/action.yml (1)

34-37: Prefer env: over shell echo for env-vars

Setting environment variables via a shell step spawns an extra process and hides intent. Use the composite-action env: block to export SCCACHE_GHA_ENABLED and RUSTC_WRAPPER in one declarative place.

-    - name: Set Rust caching env vars only on non-release runs
-      if: github.event_name != 'release'
-      run: |
-        echo "SCCACHE_GHA_ENABLED=true" >> $GITHUB_ENV
-        echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
+    - name: Set Rust caching env vars (non-release)
+      if: github.event_name != 'release'
+      env:
+        SCCACHE_GHA_ENABLED: "true"
+        RUSTC_WRAPPER: "sccache"
+      run: echo "sccache env vars exported"

Likely an incorrect or invalid review comment.

Comment thread .github/actions/setup-rust/action.yml Outdated
Comment thread .github/actions/setup-rust/CHANGELOG.md Outdated
Comment thread .github/actions/setup-rust/README.md Outdated
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: 1

♻️ Duplicate comments (1)
.github/actions/setup-rust/CHANGELOG.md (1)

9-14: Align heading style with the rest of the changelog

All earlier headings omit parentheses and dates. Maintain a consistent format by either removing the date or adopting the – YYYY-MM-DD dash style already requested in prior feedback.

-## v1.0.5 (2025-07-22)
+## v1.0.5 – 2025-07-22
📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 76be518 and 512cee7.

📒 Files selected for processing (3)
  • .github/actions/setup-rust/CHANGELOG.md (1 hunks)
  • .github/actions/setup-rust/README.md (2 hunks)
  • .github/actions/setup-rust/action.yml (2 hunks)
🔇 Additional comments (3)
.github/actions/setup-rust/README.md (2)

14-15: Inputs section reads clearly

The new inputs are documented accurately and match the action metadata.


73-78: Good clarification of separate sccache cache

The extra paragraph resolves previous ambiguity about cache scope.

.github/actions/setup-rust/action.yml (1)

38-54: Ensure cache path expands reliably on Windows runners

~ expansion is POSIX-specific and not guaranteed on Windows. Use $HOME (always set by the runner) for OS-agnostic behaviour.

-        path: ~/.cache/sccache
+        path: ${{ env.HOME }}/.cache/sccache

Comment thread .github/actions/setup-rust/action.yml Outdated
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: 4

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 512cee7 and d5f04cd.

📒 Files selected for processing (3)
  • .github/actions/setup-rust/CHANGELOG.md (1 hunks)
  • .github/actions/setup-rust/README.md (2 hunks)
  • .github/actions/setup-rust/action.yml (2 hunks)
🔇 Additional comments (1)
.github/actions/setup-rust/CHANGELOG.md (1)

9-14: Changelog entry looks ship-shape
Release date is present and bullet points concisely summarise the feature.

Comment thread .github/actions/setup-rust/action.yml
Comment thread .github/actions/setup-rust/action.yml Outdated
Comment thread .github/actions/setup-rust/README.md
Comment thread .github/actions/setup-rust/README.md
@leynos
Copy link
Copy Markdown
Owner Author

leynos commented Jul 24, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 24, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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: 1

♻️ Duplicate comments (2)
.github/actions/setup-rust/action.yml (2)

4-11: Quote the remaining boolean defaults for consistency (repeat)

install-postgres-deps and install-sqlite-deps still use unquoted false, whereas all newer inputs are quoted. Quote these values to avoid YAML boolean coercion and keep the style uniform.

-    default: false
+    default: "false"
 ...
-    default: false
+    default: "false"

49-53: Drop the redundant env-var step – sccache-action sets them (repeat)

Lines 50-53 duplicate the environment variables already exported by mozilla-actions/sccache-action. Remove the step to keep the workflow concise.

-    - name: Set Rust caching env vars only on non-release runs
-      if: ${{ inputs.use-sccache == 'true' && github.event_name != 'release' }}
-      run: |
-        echo "SCCACHE_GHA_ENABLED=true" >> $GITHUB_ENV
-        echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d5f04cd and f6c1a96.

📒 Files selected for processing (1)
  • .github/actions/setup-rust/action.yml (2 hunks)

Comment thread .github/actions/setup-rust/action.yml Outdated
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: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f6c1a96 and 5164d5e.

📒 Files selected for processing (2)
  • .github/actions/setup-rust/README.md (3 hunks)
  • .github/actions/setup-rust/action.yml (2 hunks)
🔇 Additional comments (3)
.github/actions/setup-rust/action.yml (2)

12-19: Accept the new inputs – quoting looks correct.

The added use-sccache and sccache-action-version inputs are correctly quoted, preventing YAML coercion and keeping the style consistent with earlier fixes.


38-41: Step is lean and correctly gated.

The sccache action now runs only when use-sccache is "true" and the event is not a release, matching the documented behaviour. No redundant cache or env-var steps remain.

.github/actions/setup-rust/README.md (1)

74-80: Documentation accurately reflects the sccache integration.

The section clearly explains when sccache is triggered, which variables are set, and how its cache is scoped. Good clarity for users.

Comment thread .github/actions/setup-rust/README.md
Comment thread .github/actions/setup-rust/README.md
@leynos leynos merged commit f019de7 into main Jul 24, 2025
1 check passed
@leynos leynos deleted the codex/add-sccache-to-setup-rust-action branch July 24, 2025 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant