From 6ce515bcbcba0e202cc4895456bef0a019c026c3 Mon Sep 17 00:00:00 2001
From: Jose Storopoli <jose@storopoli.io>
Date: Mon, 8 Jan 2024 14:29:05 -0300
Subject: [PATCH] ci: typos and check links (#3)

* ci: typos and check links

* fix: typos

* ci: typos
---
 .github/workflows/links.yml | 18 ++++++++++++++++++
 .github/workflows/typos.yml | 22 ++++++++++++++++++++++
 .mlc_config.json            | 25 +++++++++++++++++++++++++
 .typos.toml                 | 10 ++++++++++
 README.md                   |  2 +-
 index.qmd                   |  2 +-
 6 files changed, 77 insertions(+), 2 deletions(-)
 create mode 100644 .github/workflows/links.yml
 create mode 100644 .github/workflows/typos.yml
 create mode 100644 .mlc_config.json
 create mode 100644 .typos.toml

diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml
new file mode 100644
index 0000000..f46b84a
--- /dev/null
+++ b/.github/workflows/links.yml
@@ -0,0 +1,18 @@
+name: Markdown Links Check
+# runs every monday at 9 am
+on:
+  schedule:
+    - cron: "0 9 * * 1"
+  workflow_dispatch: null
+
+jobs:
+  check-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-quiet-mode: "yes"
+          use-verbose-mode: "yes"
+          config-file: ".mlc_config.json"
+          file-path: "./README.md, ./LICENSE, ./index.qmd"
diff --git a/.github/workflows/typos.yml b/.github/workflows/typos.yml
new file mode 100644
index 0000000..9ff6207
--- /dev/null
+++ b/.github/workflows/typos.yml
@@ -0,0 +1,22 @@
+name: Check Typos
+on:
+  push:
+      branches:
+          - master
+          - main
+  pull_request:
+      branches:
+          - master
+          - main
+  workflow_dispatch: null
+
+jobs:
+  run:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v4
+
+      - name: Check spelling
+        uses: crate-ci/typos@master
diff --git a/.mlc_config.json b/.mlc_config.json
new file mode 100644
index 0000000..7de9dbe
--- /dev/null
+++ b/.mlc_config.json
@@ -0,0 +1,25 @@
+{
+  "aliveStatusCodes": [403, 200, 206],
+  "httpHeaders": [
+    {
+      "urls": [
+        "https://github.com/",
+        "https://guides.github.com/",
+        "https://help.github.com/",
+        "https://docs.github.com/"
+      ],
+      "headers": {
+        "Accept-Encoding": "zstd, br, gzip, deflate"
+      }
+    }
+  ],
+  "retryOn429": true,
+  "ignorePatterns": [
+    {
+      "pattern": "../.*"
+    },
+    {
+      "pattern": "/github/workspace/.*"
+    }
+  ]
+}
diff --git a/.typos.toml b/.typos.toml
new file mode 100644
index 0000000..06ec16d
--- /dev/null
+++ b/.typos.toml
@@ -0,0 +1,10 @@
+[default]
+extend-ignore-re = [
+    "\\b[0-9A-Za-z+/]{91}(=|==)?\\b",  # base64 strings
+    "[0-9a-fA-F]{7,}",                 # git commit hashes
+    "\\b[0-9A-Za-z+/]{33,}(=|==)?\\b", # SHA/tpub/adresses etc strings
+]
+
+[type.gitignore]
+check-file = false
+extend-glob = [".gitignore"]
diff --git a/README.md b/README.md
index 90abca3..e60ce8e 100644
--- a/README.md
+++ b/README.md
@@ -50,6 +50,6 @@ Or in BibTeX format (LaTeX):
 
 ## License
 
-This content is licensed under [Creative Commons Attribution-ShareAlike 4.0 Internacional](http://creativecommons.org/licenses/by-sa/4.0/).
+This content is licensed under [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).
 
 [![CC BY-SA 4.0](https://licensebuttons.net/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)
diff --git a/index.qmd b/index.qmd
index dfdd9c6..49ac409 100644
--- a/index.qmd
+++ b/index.qmd
@@ -248,7 +248,7 @@ The syntax is quite similar to Python.
 
 . . .
 
-But, no identation and every keyword needs an `end`.
+But, no indentation and every keyword needs an `end`.
 
 . . .