Skip to content

#dependencies update process #242

@Dargon789

Description

@Dargon789

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])
Loading

File-Level Changes

Change Details Files
Introduced environment variables for PR metadata
  • Added env block defining GITHUB_TOKEN, BRANCH, TITLE, and BODY
  • Used envsubst to interpolate the update log into the PR body template
.github/workflows/dependencies.yml
Replaced composite workflow with inline update steps
  • Removed composite cargo-update-pr.yml usage
  • Added steps for actions/checkout and dtolnay/rust-toolchain
  • Ran cargo update with log filtering via sed and tee
.github/workflows/dependencies.yml
Added dynamic commit message and PR body generation
  • Captured update log into a file and GitHub output variables
  • Crafted commit message and body using $GITHUB_OUTPUT syntax
.github/workflows/dependencies.yml
Configured PR creation with peter-evans/create-pull-request@v6
  • Specified add-paths, commit-message, title, body, and branch inputs
  • Ensured only Cargo.lock changes are committed
.github/workflows/dependencies.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

Originally posted by @sourcery-ai[bot] in #77 (comment)

Sub-issues

Metadata

Metadata

Assignees

Labels

P-highT-bugbugSomething isn't workingdependenciesPull requests that update a dependency filedocumentationImprovements or additions to documentationduplicateThis issue or pull request already existsenhancementNew feature or requestgithub_actionsPull requests that update GitHub Actions codegood first issueGood for newcomersinvalidThis doesn't seem rightquestionFurther information is requestedrustPull requests that update rust codewontfixThis will not be worked on

Projects

Status

Backlog

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions