forked from foundry-rs/foundry
-
Notifications
You must be signed in to change notification settings - Fork 1
Open
0 / 10 of 1 issue completedLabels
P-highT-bugbugSomething isn't workingSomething isn't workingdependenciesPull requests that update a dependency filePull requests that update a dependency filedocumentationImprovements or additions to documentationImprovements or additions to documentationduplicateThis issue or pull request already existsThis issue or pull request already existsenhancementNew feature or requestNew feature or requestgithub_actionsPull requests that update GitHub Actions codePull requests that update GitHub Actions codegood first issueGood for newcomersGood for newcomersinvalidThis doesn't seem rightThis doesn't seem rightquestionFurther information is requestedFurther information is requestedrustPull requests that update rust codePull requests that update rust codewontfixThis will not be worked onThis will not be worked on
Description
Reviewer's Guide
This PR refactors the weekly dependencies update workflow by replacing a composite action with explicit steps: it checks out the repo, installs a nightly Rust toolchain, runs a filtered cargo update, dynamically generates the commit message and PR body (including the update log), and creates the PR using the peter-evans action.
Flow diagram for new dependencies update process
flowchart TD
Start([Start Workflow]) --> Checkout["actions/checkout@v4"]
Checkout --> Toolchain["dtolnay/rust-toolchain@nightly"]
Toolchain --> Update["cargo update (filtered)"]
Update --> CommitMsg["Craft commit message and PR body"]
CommitMsg --> PR["Create Pull Request"]
PR --> End([End])
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Introduced environment variables for PR metadata |
|
.github/workflows/dependencies.yml |
| Replaced composite workflow with inline update steps |
|
.github/workflows/dependencies.yml |
| Added dynamic commit message and PR body generation |
|
.github/workflows/dependencies.yml |
| Configured PR creation with peter-evans/create-pull-request@v6 |
|
.github/workflows/dependencies.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 #77 (comment)
Sub-issues
Metadata
Metadata
Assignees
Labels
P-highT-bugbugSomething isn't workingSomething isn't workingdependenciesPull requests that update a dependency filePull requests that update a dependency filedocumentationImprovements or additions to documentationImprovements or additions to documentationduplicateThis issue or pull request already existsThis issue or pull request already existsenhancementNew feature or requestNew feature or requestgithub_actionsPull requests that update GitHub Actions codePull requests that update GitHub Actions codegood first issueGood for newcomersGood for newcomersinvalidThis doesn't seem rightThis doesn't seem rightquestionFurther information is requestedFurther information is requestedrustPull requests that update rust codePull requests that update rust codewontfixThis will not be worked onThis will not be worked on
Projects
Status
Backlog
Status
Todo