From 49f27a581dd6a8283f9d191fff951b6a608501cf Mon Sep 17 00:00:00 2001 From: Raventric <78981416+Ravencentric@users.noreply.github.com> Date: Fri, 15 Sep 2023 01:09:42 +0530 Subject: [PATCH] feat: add a link checker workflow (#137) https://github.com/lycheeverse/lychee-action This will help us catch any broken links in the future --- .github/workflows/links.yml | 42 ++++++++++++++++++++++++++++++ docs/getting-started/literature.md | 2 +- 2 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/links.yml diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml new file mode 100644 index 000000000..716d191e5 --- /dev/null +++ b/.github/workflows/links.yml @@ -0,0 +1,42 @@ +name: Links + +on: + schedule: + - cron: "0 0 * * *" + +jobs: + linkChecker: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Link Checker + id: lychee + uses: lycheeverse/lychee-action@v1.8.0 + with: + args: >- + --exclude-all-private + --verbose --no-progress + --user-agent 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36' + --max-redirects 10 + --header "accept=*/*" + --accept 200,204,206,403,429 + --base 'https://thewiki.moe' + --exclude-path './docs/hidden' + --exclude '^https://www.amd.com' + --exclude '^https://exhentai.org' + --exclude '^https://www.nzbking.com' + './**/*.md' + +# Public trackers, streaming sites, crunchyroll, kodi, qbittorrent, etc return 403 +# Nyaa returns 429 +# ./docs/hidden has unmaintained legacy files +# AMD fails for reasons unknown to me, exhentai is private, and nzbking has bad uptime + + - name: Create Issue From File + if: env.lychee_exit_code != 0 + uses: peter-evans/create-issue-from-file@v4 + with: + title: Link Checker Report + content-filepath: ./lychee/out.md + labels: report, automated issue diff --git a/docs/getting-started/literature.md b/docs/getting-started/literature.md index 0423e7b75..286cc25ea 100644 --- a/docs/getting-started/literature.md +++ b/docs/getting-started/literature.md @@ -80,7 +80,7 @@ Although these are significantly lower quality, not all manga get official digit [Kavita](https://www.kavitareader.com/) - Free and open source manga, comic, and book server with OPDS support. This means that any reader with OPDS, like Perfect Viewer, [can be used to read manga from the server](https://wiki.kavitareader.com/en/guides/settings/opds). Has support for [CDisplayEX](https://wiki.kavitareader.com/en/guides/misc/cdisplayex), [Tachiyomi](https://wiki.kavitareader.com/en/guides/misc/tachiyomi), and [Paperback](https://wiki.kavitareader.com/en/guides/misc/paperback). It also has an integrated webreader. [DEMO](https://wiki.kavitareader.com/en/kavita-demo). -[Komga](https://komga.org/) - Free and open source manga server with OPDS support. This means that any reader with OPDS, like Perfect Viewer, [can be used to read manga from the server](https://komga.org/guides/opds.html). Tachiyomi and Paperback are supported through their respective [komga extensions](https://komga.org/docs/guides/tachiyomi). It also has an integrated webreader. +[Komga](https://komga.org/) - Free and open source manga server with OPDS support. This means that any reader with OPDS, like Perfect Viewer, [can be used to read manga from the server](https://komga.org/docs/guides/opds). Tachiyomi and Paperback are supported through their respective [komga extensions](https://komga.org/docs/guides/tachiyomi). It also has an integrated webreader. [komf](https://github.com/Snd-R/komf) - Komga and Kavita metadata fetcher.