Browse Source

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
pull/3454/head
Emil Ernerfeldt 1 year ago
committed by GitHub
parent
commit
b5e3502067
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 38
      .github/workflows/spelling_and_links.yml
  2. 17
      .github/workflows/typos.yml
  3. 4
      CHANGELOG.md
  4. 4
      README.md

38
.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

17
.github/workflows/typos.yml

@ -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

4
CHANGELOG.md

@ -329,7 +329,7 @@ egui_extras::install_image_loaders(egui_ctx);
### Contributors 🙏 ### Contributors 🙏
* [4JX](https://github.com/4JX) * [4JX](https://github.com/4JX)
* [AlexxxRu](https://github.com/AlexxxRu) * [a-liashenko](https://github.com/a-liashenko)
* [ascclemens](https://github.com/ascclemens) * [ascclemens](https://github.com/ascclemens)
* [awaken1ng](https://github.com/awaken1ng) * [awaken1ng](https://github.com/awaken1ng)
* [bigfarts](https://github.com/bigfarts) * [bigfarts](https://github.com/bigfarts)
@ -425,7 +425,7 @@ egui_extras::install_image_loaders(egui_ctx);
* [4JX](https://github.com/4JX) * [4JX](https://github.com/4JX)
* [55nknown](https://github.com/55nknown) * [55nknown](https://github.com/55nknown)
* [AlanRace](https://github.com/AlanRace) * [AlanRace](https://github.com/AlanRace)
* [AlexxxRu](https://github.com/AlexxxRu) * [a-liashenko](https://github.com/a-liashenko)
* [awaken1ng](https://github.com/awaken1ng) * [awaken1ng](https://github.com/awaken1ng)
* [BctfN0HUK7Yg](https://github.com/BctfN0HUK7Yg) * [BctfN0HUK7Yg](https://github.com/BctfN0HUK7Yg)
* [Bromeon](https://github.com/Bromeon) * [Bromeon](https://github.com/Bromeon)

4
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). 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%"> <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` #### `Shape::Callback`
Example: 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. `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.

Loading…
Cancel
Save