Skip to content

Commit d78fc39

Browse files
authored
Use lychee link checker instead of linkinator (#5868)
Seems like linkinator doesn't find any files: #5853 (comment) This will check all links in .md files (except CHANGELOG.md) and in toml files
1 parent 557bd56 commit d78fc39

File tree

4 files changed

+16
-12
lines changed

4 files changed

+16
-12
lines changed

.github/workflows/spelling_and_links.yml

+12-8
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,20 @@ jobs:
1515
- name: Check spelling of entire workspace
1616
uses: crate-ci/typos@master
1717

18-
linkinator:
19-
name: linkinator
18+
lychee:
19+
name: lychee
2020
runs-on: ubuntu-latest
2121
steps:
2222
- uses: actions/checkout@v4
23-
- uses: jprochazk/linkinator-action@main
23+
- name: Don't check CHANGELOG.md files
24+
# This is really stupid but lychee doesn't have a way of excluding files via GLOB:
25+
# https://github.com/lycheeverse/lychee/issues/1608
26+
27+
# We need to exclude CHANGELOG.md since we don't want to have a CI failure everytime some contributor decides
28+
# to change their username.
29+
run: rm -r */**/CHANGELOG.md CHANGELOG.md
30+
- name: Link Checker
31+
uses: lycheeverse/lychee-action@v2
2432
with:
25-
linksToSkip: "https://crates.io/crates/.*, http://localhost:.*" # Avoid crates.io rate-limiting
26-
retry: true
27-
retryErrors: true
28-
retryErrorsCount: 5
29-
retryErrorsJitter: 2000
33+
args: "'**/*.md' '**/*.toml' --exclude localhost --exclude reddit.com" # I guess reddit doesn't like github action IPs
3034

ARCHITECTURE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Thin wrapper around `egui_demo_lib` so we can compile it to a web site or a nati
5151
Depends on `egui_demo_lib` + `eframe`.
5252

5353
### `egui_kittest`
54-
A test harness for egui based on [kittest](https://github.com/rerun/kittest) and [AccessKit](https://github.com/AccessKit/accesskit/).
54+
A test harness for egui based on [kittest](https://github.com/rerun-io/kittest) and [AccessKit](https://github.com/AccessKit/accesskit/).
5555

5656
### Other integrations
5757

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Latest version](https://img.shields.io/crates/v/egui.svg)](https://crates.io/crates/egui)
55
[![Documentation](https://docs.rs/egui/badge.svg)](https://docs.rs/egui)
66
[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
7-
[![Build Status](https://github.com/emilk/egui/workflows/CI/badge.svg)](https://github.com/emilk/egui/actions?workflow=CI)
7+
[![Build Status](https://github.com/emilk/egui/workflows/Rust/badge.svg)](https://github.com/emilk/egui/actions/workflows/rust.yml)
88
[![MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/emilk/egui/blob/master/LICENSE-MIT)
99
[![Apache](https://img.shields.io/badge/license-Apache-blue.svg)](https://github.com/emilk/egui/blob/master/LICENSE-APACHE)
1010
[![Discord](https://img.shields.io/discord/900275882684477440?label=egui%20discord)](https://discord.gg/JFcEma9bJq)
@@ -353,7 +353,7 @@ Notable contributions by:
353353
* [@AsmPrgmC3](https://github.com/AsmPrgmC3): [Proper sRGBA blending for web](https://github.com/emilk/egui/pull/650)
354354
* [@AlexApps99](https://github.com/AlexApps99): [`egui_glow`](https://github.com/emilk/egui/pull/685)
355355
* [@mankinskin](https://github.com/mankinskin): [Context menus](https://github.com/emilk/egui/pull/543)
356-
* [@t18b219k](https://github.com/t18b219k): [Port glow painter to web](https://github.com/emilk/egui/pull/868)
356+
* [@KentaTheBugMaker](https://github.com/KentaTheBugMaker): [Port glow painter to web](https://github.com/emilk/egui/pull/868)
357357
* [@danielkeller](https://github.com/danielkeller): [`Context` refactor](https://github.com/emilk/egui/pull/1050)
358358
* [@MaximOsipenko](https://github.com/MaximOsipenko): [`Context` lock refactor](https://github.com/emilk/egui/pull/2625)
359359
* [@mwcampbell](https://github.com/mwcampbell): [AccessKit](https://github.com/AccessKit/accesskit) [integration](https://github.com/emilk/egui/pull/2294)

crates/eframe/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev lib
2626

2727
You need to either use `edition = "2021"`, or set `resolver = "2"` in the `[workspace]` section of your to-level `Cargo.toml`. See [this link](https://doc.rust-lang.org/edition-guide/rust-2021/default-cargo-resolver.html) for more info.
2828

29-
You can opt-in to the using [`egui_wgpu`](https://github.com/emilk/egui/tree/master/crates/egui_wgpu) for rendering by enabling the `wgpu` feature and setting `NativeOptions::renderer` to `Renderer::Wgpu`.
29+
You can opt-in to the using [`egui-wgpu`](https://github.com/emilk/egui/tree/master/crates/egui-wgpu) for rendering by enabling the `wgpu` feature and setting `NativeOptions::renderer` to `Renderer::Wgpu`.
3030

3131
## Alternatives
3232
`eframe` is not the only way to write an app using `egui`! You can also try [`egui-miniquad`](https://github.com/not-fl3/egui-miniquad), [`bevy_egui`](https://github.com/mvlabat/bevy_egui), [`egui_sdl2_gl`](https://github.com/ArjunNair/egui_sdl2_gl), and others.

0 commit comments

Comments
 (0)