From 53e3578e34e221a6ba49316b7f075fc31cea305e Mon Sep 17 00:00:00 2001 From: Philipp Oppermann Date: Sun, 17 Oct 2021 17:16:02 +0200 Subject: [PATCH] Use `crate-ci/typos` action to check for typos 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). --- .github/workflows/{build-site.yml => blog.yml} | 10 +++++----- blog/typos.toml | 13 +++++++++++++ 2 files changed, 18 insertions(+), 5 deletions(-) rename .github/workflows/{build-site.yml => blog.yml} (94%) create mode 100644 blog/typos.toml diff --git a/.github/workflows/build-site.yml b/.github/workflows/blog.yml similarity index 94% rename from .github/workflows/build-site.yml rename to .github/workflows/blog.yml index 9bf498e1..882b8fad 100644 --- a/.github/workflows/build-site.yml +++ b/.github/workflows/blog.yml @@ -1,4 +1,4 @@ -name: Build Site +name: Blog on: push: @@ -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/typos@v1.1.9 + with: + files: blog deploy_site: name: "Deploy Generated Site" diff --git a/blog/typos.toml b/blog/typos.toml new file mode 100644 index 00000000..16e52eb3 --- /dev/null +++ b/blog/typos.toml @@ -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