Skip to content

T8484: typos check workflow added#110

Merged
dmbaturin merged 1 commit intocurrentfrom
T8484-typos-check-workflow
Apr 13, 2026
Merged

T8484: typos check workflow added#110
dmbaturin merged 1 commit intocurrentfrom
T8484-typos-check-workflow

Conversation

@kumvijaya
Copy link
Copy Markdown
Contributor

@kumvijaya kumvijaya commented Apr 12, 2026

Change Summary

New GitHub Actions reusable workflow that automatically checks for spelling mistakes (typos) in pull requests. Runs on every PR and reports issues with clickable links to the exact locations in the code.

How It Reports Issues

  • Automated PR Comments: Posts a formatted table showing each typo with file:line link
  • Clickable Links: Direct GitHub blob URLs to the exact line where typo was found
  • Auto-Updates: Comment refreshes when new commits are pushed (no duplicates)
  • Format:
    ❌ Typos detected in PR (N found)
    | File | Typo | Suggestion |
    | [file.txt:5](link) | typo | correction |
    

Configuration (Optional)

.typos.toml is not required — workflow works out of the box.

Default exclusions (included automatically):

[files]
extend-exclude = [
  "smoketest/**",
  "mibs/**"
]

Add .typos.toml to your repository only if you need additional exclusions or customizations:

[files]
extend-exclude = [
  "smoketest/**",
  "mibs/**",
  "docs/**",
  "vendor/**"
]

Setup

  1. (Optional) Add .typos.toml to your repository if you need custom exclusions
  2. Workflow runs automatically on pull requests
  3. No configuration needed for default behavior (smoketest/ and mibs/ already excluded)

How to Use

Create a workflow file in your repository that calls this reusable workflow:

name: Check Typos

on:
  pull_request_target:
    types: [opened, synchronize]

jobs:
  typos:
    uses: vyos/.github/.github/workflows/check-typos.yml@T8484-typos-check-workflow

Powered by: typos-cli v1.44.0

Validation
Tested with vyos/gh-action-test-vyos-1x#251 (comment)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes)
  • Other (please describe):

Related Task(s)

https://vyos.dev/T8484

Related PR(s)

Proposed changes

How to test

Checklist:

  • I have read the CONTRIBUTING document
  • I have linked this PR to one or more Phabricator Task(s)
  • My commit headlines contain a valid Task id
  • My change requires a change to the documentation
  • I have updated the documentation accordingly

T8484: added typos check reusable workflow, installed cli via cargo

T8484: added typos check reusable workflow, installed cli via cargo with pinned version, and cache added

T8484: added typos check reusable workflow, fixing typos missing spells issue

T8484: added typos check reusable workflow, checkout branch issue fixed

T8484: added typos check reusable workflow, reporting format update

T8484: added typos check reusable workflow, reporting format update

T8484: added typos check reusable workflow, moving as script

T8484: added typos check reusable workflow, moving as script

T8484: added typos check reusable workflow, updated reporting format

T8484: added typos check reusable workflow, updated reporting format

T8484: typos check workflow updated to format comment

T8484: typos check workflow updated to format comment

T8484: typos check workflow updated to format comment

T8484: typos check updated toml

T8484: typos check debug

T8484: typos check debug

T8484: typos check debug

T8484: typos check debug

T8484: typos file list fix

T8484: typos file list fix

T8484: typos workflow ref fixed
Copy link
Copy Markdown
Member

@sever-sever sever-sever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Workflow to check typos/mistakes in new PRs

Copy link
Copy Markdown
Member

@dmbaturin dmbaturin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's try it and see how it goes, especially with respect to the rate of false positives.

@dmbaturin dmbaturin merged commit 89ba263 into current Apr 13, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants