forked from googleapis/google-cloud-node
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
good first issueGood for newcomersGood for newcomers
Description
Reviewer's Guide
Adds a CircleCI job configuration for building, formatting, and testing the Rust project using cargo with caching of dependencies and build artifacts.
Flow diagram for CircleCI cargo build-and-test job steps
flowchart TD
S["Start build-and-test job"] --> A["Checkout repository"]
A --> B["Restore cache with keys: v1-cargo-{{ checksum 'Cargo.lock' }}, v1-cargo-"]
B --> C["Run: cargo fmt -- --check (first formatting check)"]
C --> D["Run: cargo test (first test run)"]
D --> E["Save cache with key: v1-cargo-{{ checksum 'Cargo.lock' }}"]
E --> F["Cache path: ~/.cargo/bin"]
F --> G["Cache path: ~/.cargo/registry/index"]
G --> H["Cache path: ~/.cargo/registry/cache"]
H --> I["Cache path: ~/.cargo/git/db"]
I --> J["Cache path: target"]
J --> K["Run: cargo fmt -- --check (second formatting check)"]
K --> L["Run: cargo test (second test run)"]
L --> T["End build-and-test job"]
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Introduce a CircleCI workflow to build, format-check, and test the Rust project with cached cargo artifacts. |
|
.circleci/cargo.yml |
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon 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 issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment@sourcery-ai summaryon the pull request to
(re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull
request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon 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 dismisson 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 reviewto 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
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.
Originally posted by @sourcery-ai[bot] in #221 (comment)
Metadata
Metadata
Assignees
Labels
good first issueGood for newcomersGood for newcomers
Projects
Status
Backlog
Status
Todo