Skip to content

Commit

Permalink
Use crate-ci/typos action to check for typos
Browse files Browse the repository at this point in the history
The misspell tool that we used previously has no exclude switch for ignoring translated files. Also, it looks like it is not maintained anymore.

In addition to changing our spell checker, this commit renames the `Build Site` workflow to `Blog` (to be consistent with our `Code` workflow).
  • Loading branch information
phil-opp committed Oct 17, 2021
1 parent ac8f017 commit 53e3578
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/build-site.yml → .github/workflows/blog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build Site
name: Blog

on:
push:
Expand Down Expand Up @@ -59,10 +59,10 @@ jobs:
steps:
- uses: actions/checkout@v1

- run: curl -L https://git.io/misspell | bash
name: "Install misspell"
- run: bin/misspell -error blog/content
name: "Check for common typos"
- name: Typo Check
uses: crate-ci/[email protected]
with:
files: blog

deploy_site:
name: "Deploy Generated Site"
Expand Down
13 changes: 13 additions & 0 deletions blog/typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[files]
extend-exclude = [
"*.svg",
"*.zh-CN.md",
"*.ja.md",
]

[default.extend-words]
IST = "IST" # Interrupt Stack Table

[default.extend-identifiers]
TheBegining = "TheBegining" # GitHub user mentioned in status reports
h015bf61815bb8afe = "h015bf61815bb8afe" # mangled name used in code example

0 comments on commit 53e3578

Please sign in to comment.