Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR bumps the Cross tool version in the GitHub Actions release workflow from v0.2.1 to v0.2.5 and adds a new reference file for cross-linking. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Summary by CodeRabbit
WalkthroughUpdate the GitHub Actions release workflow to use Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (4)
CRUSH.md (3)
5-7: Remove second‑person pronoun to comply with style guide.Avoid “your”. Use impersonal imperative.
Apply:
-- **Code is for humans.** Write your code with clarity and empathy—assume a - tired teammate will need to debug it at 3 a.m. +- **Code is for humans.** Write code with clarity and empathy—assume a tired + teammate will need to debug it at 3 a.m.
55-61: Normalise terminology and en‑GB spelling.Use “unit tests” and “behavioural”.
Apply:
- - New functionality or changes in behaviour are fully validated by relevant - unittests and behavioural tests. + - New functionality or changes in behaviour are fully validated by relevant + unit tests and behavioural tests. @@ - - Passes all relevant unit and behavioral tests according to the guidelines + - Passes all relevant unit and behavioural tests according to the guidelines
171-174: Use “entry point” (two words) in en‑GB.Apply:
- API boundaries, and to `eyre` only in the main `main()` entrypoint or + API boundaries, and to `eyre` only in the main `main()` entry point or.github/workflows/release.yml (1)
61-68: Guard installation on cache hit and lock dependency resolution.Without an install guard,
cargo installcan fail when the cached binary exists. Lock dependencies for reproducibility.Apply:
- name: Cache cross binary uses: actions/cache@v4 with: path: ~/.cargo/bin/cross - key: cross-v0.2.5-${{ runner.os }} + key: cross-v0.2.5-${{ runner.os }} + id: cache-cross - name: Install cross - run: cargo install cross --git https://github.com/cross-rs/cross --tag v0.2.5 + if: steps.cache-cross.outputs.cache-hit != 'true' + run: cargo install cross --locked --git https://github.com/cross-rs/cross --tag v0.2.5
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
.github/workflows/release.yml(1 hunks).gitignore(1 hunks)CRUSH.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit Inference Engine (AGENTS.md)
**/*.md: Documentation must use en-GB-oxendict spelling and grammar. (EXCEPTION: the naming of the "LICENSE" file, which is to be left unchanged for community consistency.)
Validate Markdown files usingmake markdownlint.
Runmake fmtafter any documentation changes to format all Markdown files and fix table markup.
Validate Mermaid diagrams in Markdown files by runningmake nixie.
Markdown paragraphs and bullet points must be wrapped at 80 columns.
Code blocks must be wrapped at 120 columns.
Tables and headings must not be wrapped.
Use dashes (-) for list bullets.
Use GitHub-flavoured Markdown footnotes ([^1]) for references and footnotes.
Files:
CRUSH.md
⚙️ CodeRabbit Configuration File
**/*.md: * Avoid 2nd person or 1st person pronouns ("I", "you", "we")
- Use en-GB-oxendict (-ize / -our) spelling and grammar
- Paragraphs and bullets must be wrapped to 80 columns, except where a long URL would prevent this (in which case, silence MD013 for that line)
- Code blocks should be wrapped to 120 columns.
- Headings must not be wrapped.
- Documents must start with a level 1 heading
- Headings must correctly increase or decrease by no more than one level at a time
- Use GitHub-flavoured Markdown style for footnotes and endnotes.
- Numbered footnotes must be numbered by order of appearance in the document.
Files:
CRUSH.md
🔇 Additional comments (3)
CRUSH.md (2)
1-1: Replace stray filename with a level‑1 heading aligned to this file.The file must start with an H1 heading and not with an unrelated filename.
Apply:
-AGENTS.md +# Contribution and Quality Rules (CRUSH)Likely an incorrect or invalid review comment.
176-188: Validate and format Markdown per repository rules. The sandbox environment doesn’t providemake, so run these checks in your local setup:
- Run
make markdownlintto lint Markdown files.- Run
make fmtto format Markdown and fix table markup.- Run
make nixieto validate Mermaid diagrams.Ensure all commands complete without errors before merging.
.gitignore (1)
3-3: LGTM.Ignore
.crushalongside existing patterns.
| key: cross-v0.2.5-${{ runner.os }} | ||
| - name: Install cross | ||
| run: cargo install cross --git https://github.com/cross-rs/cross --tag v0.2.1 | ||
| run: cargo install cross --git https://github.com/cross-rs/cross --tag v0.2.5 |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Optionally use a dedicated installer for speed and reliability.
Use a setup action or binstall to avoid compiling from source on cache miss.
For example:
-
Use taiki-e/install-action:
- uses: taiki-e/install-action@v2
with:
tool: cross@0.2.5
- uses: taiki-e/install-action@v2
-
Or use cargo-binstall:
- name: Install cargo-binstall
run: curl -L https://github.com/cargo-bins/cargo-binstall/releases/latest/download/cargo-binstall-$(uname -s | tr '[:upper:]' '[:lower:]')-$(uname -m).tgz | tar -xz -C ~/.cargo/bin - name: Install cross
run: cargo binstall -y cross@0.2.5
- name: Install cargo-binstall
🤖 Prompt for AI Agents
In .github/workflows/release.yml around lines 65 to 67, the current step
installs cross by compiling from source, which is slower and less reliable.
Replace this with a dedicated installer action like taiki-e/install-action or
use cargo-binstall to install cross precompiled. This will speed up the workflow
and improve reliability by avoiding source compilation on cache misses.
1 participant
Summary by Sourcery
Update the GitHub Actions release workflow to use cross v0.2.5 and add a CRUSH.md reference file.
CI:
Documentation: