From b5e350206758bd1b89d7dea26edeb024b4cf6329 Mon Sep 17 00:00:00 2001
From: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
Date: Sun, 8 Oct 2023 09:30:54 +0200
Subject: [PATCH] Add link checking to CI (#3445)

* Add link checking to CI, plus another spell checker

* Only spell-check markdown

* Avoid rate-limiting

* Fix some links

* Disable cspell
---
 .github/workflows/spelling_and_links.yml | 38 ++++++++++++++++++++++++
 .github/workflows/typos.yml              | 17 -----------
 CHANGELOG.md                             |  4 +--
 README.md                                |  4 +--
 4 files changed, 42 insertions(+), 21 deletions(-)
 create mode 100644 .github/workflows/spelling_and_links.yml
 delete mode 100644 .github/workflows/typos.yml

diff --git a/.github/workflows/spelling_and_links.yml b/.github/workflows/spelling_and_links.yml
new file mode 100644
index 000000000..2b4c8de14
--- /dev/null
+++ b/.github/workflows/spelling_and_links.yml
@@ -0,0 +1,38 @@
+name: Check spelling and links
+on: [pull_request]
+
+jobs:
+  typos:
+    # https://github.com/crate-ci/typos
+    # Add exceptions to _typos.toml
+    # install and run locally: cargo install typos-cli && typos
+    name: typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v4
+
+      - name: Check spelling of entire workspace
+        uses: crate-ci/typos@master
+  # Disabled: too many names of crates and user-names etc
+  # spellcheck:
+  #   name: Spellcheck
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - uses: streetsidesoftware/cspell-action@v2
+  #       with:
+  #         files: "**/*.md"
+  linkinator:
+    name: linkinator
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jprochazk/linkinator-action@main
+        with:
+          linksToSkip: "https://crates.io/crates/.*, http://localhost:.*" # Avoid crates.io rate-limiting
+          retry: true
+          retryErrors: true
+          retryErrorsCount: 5
+          retryErrorsJitter: 2000
+
diff --git a/.github/workflows/typos.yml b/.github/workflows/typos.yml
deleted file mode 100644
index 6ed556936..000000000
--- a/.github/workflows/typos.yml
+++ /dev/null
@@ -1,17 +0,0 @@
-# https://github.com/crate-ci/typos
-# Add exceptions to _typos.toml
-# install and run locally: cargo install typos-cli && typos
-
-name: Spell Check
-on: [pull_request]
-
-jobs:
-  run:
-    name: Spell Check
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Actions Repository
-        uses: actions/checkout@v4
-
-      - name: Check spelling of entire workspace
-        uses: crate-ci/typos@master
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e57ab5389..8e4da4186 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -329,7 +329,7 @@ egui_extras::install_image_loaders(egui_ctx);
 
 ### Contributors 🙏
 * [4JX](https://github.com/4JX)
-* [AlexxxRu](https://github.com/AlexxxRu)
+* [a-liashenko](https://github.com/a-liashenko)
 * [ascclemens](https://github.com/ascclemens)
 * [awaken1ng](https://github.com/awaken1ng)
 * [bigfarts](https://github.com/bigfarts)
@@ -425,7 +425,7 @@ egui_extras::install_image_loaders(egui_ctx);
 * [4JX](https://github.com/4JX)
 * [55nknown](https://github.com/55nknown)
 * [AlanRace](https://github.com/AlanRace)
-* [AlexxxRu](https://github.com/AlexxxRu)
+* [a-liashenko](https://github.com/a-liashenko)
 * [awaken1ng](https://github.com/awaken1ng)
 * [BctfN0HUK7Yg](https://github.com/BctfN0HUK7Yg)
 * [Bromeon](https://github.com/Bromeon)
diff --git a/README.md b/README.md
index cbfa92eb4..520304b14 100644
--- a/README.md
+++ b/README.md
@@ -298,7 +298,7 @@ Yes! You can customize the colors, spacing, fonts and sizes of everything using
 
 This is not yet as powerful as say CSS, [but this is going to improve soon](https://github.com/emilk/egui/issues/3284).
 
-Here is an example (from https://github.com/AlexxxRu/TinyPomodoro):
+Here is an example (from https://github.com/a-liashenko/TinyPomodoro):
 
 <img src="media/pompodoro-skin.png" width="50%">
 
@@ -332,7 +332,7 @@ If you want to embed 3D into an egui view there are two options.
 
 #### `Shape::Callback`
 Example:
-* <https://github.com/emilk/egui/blob/master/examples/custom_3d_glow.rs>
+* <https://github.com/emilk/egui/blob/master/examples/custom_3d_glow/src/main.rs>
 
 `Shape::Callback` will call your code when egui gets painted, to show anything using whatever the background rendering context is. When using [`eframe`](https://github.com/emilk/egui/tree/master/crates/eframe) this will be [`glow`](https://github.com/grovesNL/glow). Other integrations will give you other rendering contexts, if they support `Shape::Callback` at all.