From 88c34abe2c6572d401e0bd77d2aec4138bd2c88b Mon Sep 17 00:00:00 2001
From: Jean SIMARD <woshilapin@tuziwo.info>
Date: Thu, 19 Oct 2023 15:34:17 +0200
Subject: [PATCH] feat(ci): add 'typos' check (#317)

* docs(docker): fix typos

* docs(readme): fix typos

* docs(template): fix typos

* ci(typos): add 'typos' check

resolves #311

* ci(typos): 'typos' moved to its own job

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
---
 .github/workflows/ci.yml           | 9 +++++++++
 Dockerfile                         | 2 +-
 README.md                          | 2 +-
 typos.toml                         | 5 +++++
 website/docs/templating/context.md | 6 +++---
 5 files changed, 19 insertions(+), 5 deletions(-)
 create mode 100644 typos.toml

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 6b2ce31..98dbc40 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -30,6 +30,15 @@ jobs:
           command: check
           args: --locked --no-default-features --verbose
 
+  typos:
+    name: Typos
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Check typos
+        uses: crate-ci/typos@master
+
   test:
     name: Test suite
     runs-on: ubuntu-22.04
diff --git a/Dockerfile b/Dockerfile
index 3db4b84..19285b1 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -27,7 +27,7 @@ WORKDIR app
 
 # Even if the repository as marked as safe, GitHub Actions and some other
 # environments insist on running the entrypoint as root inside the container
-# even when being run by a non priviledged user on their own files. Here we
+# even when being run by a non privileged user on their own files. Here we
 # check the ownership of the workdir (which may or may not be /app) and change
 # our effective user/group ID to match.
 RUN cat <<'EOF' > /usr/local/bin/entrypoint.sh
diff --git a/README.md b/README.md
index b8ba7d3..e9b9dbe 100644
--- a/README.md
+++ b/README.md
@@ -57,7 +57,7 @@ Learn how to use **git-cliff** from the [documentation](https://git-cliff.org/do
 
 ## Editor Support
 
-- [git-cliff.el](https://github.com/liuyinz/git-cliff.el) - Genarate, update and release changelog in Emacs
+- [git-cliff.el](https://github.com/liuyinz/git-cliff.el) - Generate, update and release changelog in Emacs
 
 ## Similar/Related Projects
 
diff --git a/typos.toml b/typos.toml
new file mode 100644
index 00000000..dce7525
--- /dev/null
+++ b/typos.toml
@@ -0,0 +1,5 @@
+[type.md]
+extend-ignore-re = [
+  "\\[[[:xdigit:]]{7}\\]\\(https://github.com/orhun/git-cliff/commit/[[:xdigit:]]{40}\\)",
+  "\\[halp\\]\\(https://github.com/orhun/halp\\)",
+]
diff --git a/website/docs/templating/context.md b/website/docs/templating/context.md
index ad0a4dc..9ba2daa 100644
--- a/website/docs/templating/context.md
+++ b/website/docs/templating/context.md
@@ -27,7 +27,7 @@ following context is generated to use for templating:
   "commits": [
     {
       "id": "e795460c9bb7275294d1fa53a9d73258fb51eb10",
-      "group": "<type> (overrided by commit_parsers)",
+      "group": "<type> (overridden by commit_parsers)",
       "scope": "[scope]",
       "message": "<description>",
       "body": "[body]",
@@ -124,8 +124,8 @@ If [`conventional_commits`](/docs/configuration#conventional_commits) is set to
   "commits": [
     {
       "id": "e795460c9bb7275294d1fa53a9d73258fb51eb10",
-      "group": "(overrided by commit_parsers)",
-      "scope": "(overrided by commit_parsers)",
+      "group": "(overridden by commit_parsers)",
+      "scope": "(overridden by commit_parsers)",
       "message": "(full commit message including description, footers, etc.)",
       "conventional": false,
       "links": [