Skip to content

Add typos workflow#1

Merged
ringods merged 2 commits into
mainfrom
add-typos-workflow
May 18, 2026
Merged

Add typos workflow#1
ringods merged 2 commits into
mainfrom
add-typos-workflow

Conversation

@ringods
Copy link
Copy Markdown
Contributor

@ringods ringods commented May 18, 2026

Summary by Sourcery

CI:

  • Introduce a typos-based spell-check workflow that runs on pushes to main and on all pull requests using a shared configuration file.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 18, 2026

Reviewer's Guide

Adds a GitHub Actions workflow to run the typos spell-checker on pushes to main and on all pull requests, using pinned action SHAs and a shared typos configuration file.

Sequence diagram for new typos GitHub Actions workflow

sequenceDiagram
    participant GitHub as GitHub
    participant Workflow as typos_workflow
    participant Checkout as actions_checkout_v6
    participant Typos as crate_ci_typos

    GitHub->>Workflow: trigger push on main
    GitHub->>Workflow: trigger pull_request on branches **
    Workflow->>Checkout: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
    Checkout-->>Workflow: repository files
    Workflow->>Typos: crate-ci/typos@5374cbf686e897b15713110e233094e2874de7ef
    Typos->>Typos: load .config/typos.toml
    Typos-->>Workflow: spell check results
    Workflow-->>GitHub: job status and annotations
Loading

File-Level Changes

Change Details Files
Introduces a CI workflow that runs the typos spell-checker in GitHub Actions.
  • Adds a new workflow triggered on pushes to main and all pull requests.
  • Configures the workflow job to run on ubuntu-latest with minimal read-only permissions for repository contents.
  • Checks out the repository using a pinned version of actions/checkout with credentials persistence disabled.
  • Runs the crate-ci/typos action at a pinned version, pointing it at .config/typos.toml for configuration.
.github/workflows/typos.yaml

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

Copy link
Copy Markdown

@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 - 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.

@ringods ringods merged commit ba12df4 into main May 18, 2026
2 checks passed
@ringods ringods deleted the add-typos-workflow branch May 18, 2026 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant