Skip to content

Update CI workflow with rust cache step#136

Merged
leynos merged 3 commits intomainfrom
codex/add-rust-cache-to-ci-workflow
Jun 26, 2025
Merged

Update CI workflow with rust cache step#136
leynos merged 3 commits intomainfrom
codex/add-rust-cache-to-ci-workflow

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 25, 2025

Summary

  • speed up CI builds by adding Swatinem/rust-cache

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

CI:

  • Introduce Swatinem/rust-cache@v2 to cache ~/.cargo and target/ directories for faster Rust CI runs.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 25, 2025

Reviewer's Guide

Enhances the GitHub Actions CI by adding a Swatinem/rust-cache step to persist Rust build artifacts (cargo registry and target directory), reducing build times on subsequent runs.

File-Level Changes

Change Details Files
Introduce Rust caching step in CI workflow
  • Add Swatinem/rust-cache@v2 after installing rustfmt and clippy
  • Include comment explaining caching of ~/.cargo and target/ directories
.github/workflows/ci.yml

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 Jun 25, 2025

Summary by CodeRabbit

  • Chores
    • Improved continuous integration workflow by adding enhanced caching for Rust dependencies and build outputs, resulting in potentially faster build times.

Summary by CodeRabbit

  • Chores
    • Improved build performance by adding enhanced caching to the continuous integration process.

Walkthrough

The CI workflow configuration for the Rust project was updated to introduce a caching step using the Swatinem/rust-cache@v2 GitHub Action. This step is positioned after the Rust toolchain setup and before the existing cargo registry cache, targeting standard Rust cache directories to optimise build times. No other workflow logic was altered.

Changes

File(s) Summary of Changes
.github/workflows/ci.yml Added a Swatinem/rust-cache@v2 step after Rust toolchain setup to cache ~/.cargo and target/ directories.

Sequence Diagram(s)

sequenceDiagram
    participant GitHub Actions
    participant Rust Toolchain Setup
    participant Swatinem/rust-cache
    participant Cargo Registry Cache
    participant Build Steps

    GitHub Actions->>Rust Toolchain Setup: Set up Rust toolchain
    GitHub Actions->>Swatinem/rust-cache: Cache Rust directories (~/.cargo, target/)
    GitHub Actions->>Cargo Registry Cache: Cache cargo registry
    GitHub Actions->>Build Steps: Run build and test steps
Loading

Possibly related PRs

Suggested reviewers

  • codescene-delta-analysis

Poem

In the warren where code does hop,
A cache was added—no need to stop!
Rusty builds now leap ahead,
With artefacts snug in their bed.
Swatinem’s cache keeps things spry,
As workflows zip quickly by!
🥕✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5b10ebe and 6a1f2e5.

📒 Files selected for processing (1)
  • .github/workflows/ci.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-test
🔇 Additional comments (1)
.github/workflows/ci.yml (1)

24-26: Pinned SHA resolves previous security finding
Great job pinning Swatinem/rust-cache to the immutable commit 9d47c6ad… and documenting the version (# v2.7.8). This eliminates the supply-chain risk flagged in earlier reviews.

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/add-rust-cache-to-ci-workflow

🪧 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 auto-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 and they look great!


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.

Comment thread .github/workflows/ci.yml Fixed
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

🔭 Outside diff range comments (1)
.github/workflows/ci.yml (1)

24-33: Eliminate the now-redundant manual cargo registry/target cache step.

Swatinem/rust-cache already caches both ~/.cargo (registry & git) and the whole target/ directory. Keeping the subsequent actions/cache step duplicates cache uploads/downloads, lengthening CI time and increasing storage consumption.

Options:

  1. Remove the actions/cache@v4 step entirely.
  2. If you need fine-grained control (e.g. separate debug/release keys), restrict rust-cache with cache-directories and keep only one cache mechanism.

Removing is usually simpler:

-      - name: Cache cargo registry
-        uses: actions/cache@v4
-        with:
-          path: |
-            ~/.cargo/registry
-            ~/.cargo/git
-            target/${{ env.BUILD_PROFILE }}
-          key: ${{ runner.os }}-cargo-${{ env.BUILD_PROFILE }}-${{ hashFiles('**/Cargo.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-cargo-${{ env.BUILD_PROFILE }}-
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d9e5bdf and 5b10ebe.

📒 Files selected for processing (1)
  • .github/workflows/ci.yml (1 hunks)
🧰 Additional context used
🪛 GitHub Check: CodeQL
.github/workflows/ci.yml

[warning] 25-25: Unpinned tag for a non-immutable Action in workflow
Unpinned 3rd party Action 'CI' step Uses Step uses 'Swatinem/rust-cache' with ref 'v2', not a pinned commit hash

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-test

Comment thread .github/workflows/ci.yml Outdated
Comment thread .github/workflows/ci.yml Fixed
@leynos leynos merged commit 6b4e6ec into main Jun 26, 2025
5 checks passed
@leynos leynos deleted the codex/add-rust-cache-to-ci-workflow branch June 26, 2025 00:38
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.

2 participants