From d78fc39386e28ec7a18bd48a28a688177f090bd4 Mon Sep 17 00:00:00 2001 From: Lucas Meurer Date: Thu, 3 Apr 2025 09:26:49 +0200 Subject: [PATCH] Use lychee link checker instead of linkinator (#5868) Seems like linkinator doesn't find any files: https://github.com/emilk/egui/pull/5853#issuecomment-2765526298 This will check all links in .md files (except CHANGELOG.md) and in toml files --- .github/workflows/spelling_and_links.yml | 22 +++++++++++++--------- ARCHITECTURE.md | 2 +- README.md | 4 ++-- crates/eframe/README.md | 2 +- 4 files changed, 17 insertions(+), 13 deletions(-) diff --git a/.github/workflows/spelling_and_links.yml b/.github/workflows/spelling_and_links.yml index d7b32b00..8fb16ae2 100644 --- a/.github/workflows/spelling_and_links.yml +++ b/.github/workflows/spelling_and_links.yml @@ -15,16 +15,20 @@ jobs: - name: Check spelling of entire workspace uses: crate-ci/typos@master - linkinator: - name: linkinator + lychee: + name: lychee 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 + - name: Don't check CHANGELOG.md files + # This is really stupid but lychee doesn't have a way of excluding files via GLOB: + # https://github.com/lycheeverse/lychee/issues/1608 + + # We need to exclude CHANGELOG.md since we don't want to have a CI failure everytime some contributor decides + # to change their username. + run: rm -r */**/CHANGELOG.md CHANGELOG.md + - name: Link Checker + uses: lycheeverse/lychee-action@v2 + with: + args: "'**/*.md' '**/*.toml' --exclude localhost --exclude reddit.com" # I guess reddit doesn't like github action IPs diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 000f2b7a..51d6d41d 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -51,7 +51,7 @@ Thin wrapper around `egui_demo_lib` so we can compile it to a web site or a nati Depends on `egui_demo_lib` + `eframe`. ### `egui_kittest` -A test harness for egui based on [kittest](https://github.com/rerun/kittest) and [AccessKit](https://github.com/AccessKit/accesskit/). +A test harness for egui based on [kittest](https://github.com/rerun-io/kittest) and [AccessKit](https://github.com/AccessKit/accesskit/). ### Other integrations diff --git a/README.md b/README.md index 63e5f3ad..087d2aad 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Latest version](https://img.shields.io/crates/v/egui.svg)](https://crates.io/crates/egui) [![Documentation](https://docs.rs/egui/badge.svg)](https://docs.rs/egui) [![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/) -[![Build Status](https://github.com/emilk/egui/workflows/CI/badge.svg)](https://github.com/emilk/egui/actions?workflow=CI) +[![Build Status](https://github.com/emilk/egui/workflows/Rust/badge.svg)](https://github.com/emilk/egui/actions/workflows/rust.yml) [![MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/emilk/egui/blob/master/LICENSE-MIT) [![Apache](https://img.shields.io/badge/license-Apache-blue.svg)](https://github.com/emilk/egui/blob/master/LICENSE-APACHE) [![Discord](https://img.shields.io/discord/900275882684477440?label=egui%20discord)](https://discord.gg/JFcEma9bJq) @@ -353,7 +353,7 @@ Notable contributions by: * [@AsmPrgmC3](https://github.com/AsmPrgmC3): [Proper sRGBA blending for web](https://github.com/emilk/egui/pull/650) * [@AlexApps99](https://github.com/AlexApps99): [`egui_glow`](https://github.com/emilk/egui/pull/685) * [@mankinskin](https://github.com/mankinskin): [Context menus](https://github.com/emilk/egui/pull/543) -* [@t18b219k](https://github.com/t18b219k): [Port glow painter to web](https://github.com/emilk/egui/pull/868) +* [@KentaTheBugMaker](https://github.com/KentaTheBugMaker): [Port glow painter to web](https://github.com/emilk/egui/pull/868) * [@danielkeller](https://github.com/danielkeller): [`Context` refactor](https://github.com/emilk/egui/pull/1050) * [@MaximOsipenko](https://github.com/MaximOsipenko): [`Context` lock refactor](https://github.com/emilk/egui/pull/2625) * [@mwcampbell](https://github.com/mwcampbell): [AccessKit](https://github.com/AccessKit/accesskit) [integration](https://github.com/emilk/egui/pull/2294) diff --git a/crates/eframe/README.md b/crates/eframe/README.md index 5ffd427d..6f3f4400 100644 --- a/crates/eframe/README.md +++ b/crates/eframe/README.md @@ -26,7 +26,7 @@ sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev lib 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. -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`. +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`. ## Alternatives `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.