Skip to content

Commit

Permalink
Adding workflow to automatically create typo PRs (cosmos#5724)
Browse files Browse the repository at this point in the history
* chore: adding workflow and note in CONTRIBUTING.md

* chore: clean up workflow

* Update CONTRIBUTING.md

---------

Co-authored-by: Carlos Rodriguez <[email protected]>
  • Loading branch information
chatton and Carlos Rodriguez authored Jan 26, 2024
1 parent 574a639 commit 9b2aaf7
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/.misspell-fixer.ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
\*.pb.go
25 changes: 25 additions & 0 deletions .github/workflows/spell-checker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Fix typos nightly

on:
workflow_dispatch: {} # enable manual running of workflow.
schedule:
- cron: "0 8 * * *"

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: sobolevn/misspell-fixer-action@e5368f1b21585248afad4d32df9bc100451dbbff
- uses: peter-evans/create-pull-request@v5
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "chore: fixes by misspell-fixer"
title: "chore: typos fix by misspell-fixer"
branch: "bot/fix-typos"
delete-branch: true
body: |
This PR fixes typos in the codebase.
Please, review it and merge if everything is fine.
If there are proto changes, please, run `make proto-all` and commit changes.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ If you would like to contribute, follow this process:

Please make sure to check out our [Pull request guidelines](./docs/dev/pull-requests.md) for more information.

> Note: At this time, we will not be accepting contributions that only fix spelling
> or grammar errors in documentation, code or elsewhere. The repository has a nightly job that
> spell checks all files and will automatically open PRs for any spelling errors.
## Relevant development docs

- [Project structure](./docs/dev/project-structure.md)
Expand Down

0 comments on commit 9b2aaf7

Please sign in to comment.