[Feature] Broken Link Checker - Github Action

[JuanPabloDiaz]

Description

I believe that it will be a great idea to setup a GitHub action that runs periodically and checks for broken links.

I just implemented it in my project and I would like to share my knowledge and received feedback to make it better.

Screenshots

here is an example from my own project:

Checklist

• [X] I have checked the existing issues
• [X] I have read the Contributing Guidelines
• [X] I am willing to work on this issue (optional)

[github-actions[bot]]

2349, #2339, #2338, #2322 is already opened by you

As per contributing guidelines, you can only work on 1 issue at a time.

[github-actions[bot]]

Hello JuanPabloDiaz! Thank you for raising this issue! 😊 Your contribution is valuable to us! 😊

Please make sure to follow our Contributing Guidelines. 💪🏻

Please only work on an issue if you're assigned; otherwise, the PR will be automatically closed. Our review team will carefully assess the issue and reach out to you soon! 😇 We appreciate your patience!

[CBID2]

That seems possible @JuanPabloDiaz. @rupali-codes, @Anmol-Baranwal, @aftabrehan, thoughts?

[rupali-codes]

That seems possible @JuanPabloDiaz. @rupali-codes, @Anmol-Baranwal, @aftabrehan, thoughts?

it seems great though, but how does that actually work @JuanPabloDiaz ?

[JuanPabloDiaz]

That seems possible @JuanPabloDiaz. @rupali-codes, @Anmol-Baranwal, @aftabrehan, thoughts?

it seems great though, but how does that actually work @JuanPabloDiaz ?

Github action to check for broken links in Markdown, HTML, and text files using Lychee, a fast link checker written in Rust.

Here is a full example of a GitHub workflow file:

It will check all repository links once per day and create an issue in case of errors.

name: Links

on:
  repository_dispatch:
  workflow_dispatch:
  schedule:
    - cron: "00 18 * * *"

jobs:
  linkChecker:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Link Checker
        id: lychee
        uses: lycheeverse/lychee-action@v1

      - 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

[Anmol-Baranwal]

@rupali-codes

The URLs is in json files (this codebase), so maybe try this in a sample private repo to see if it works.

[JuanPabloDiaz]

Project implementations:

• documentation.breadnet.co.uk ---> GitHub action
• freeForGeeks ---> GitHub action

[JuanPabloDiaz]

I'd like to share my experience with Lychee. I came across it yesterday and integrated it into my project. While it was helpful in identifying some broken links, it also generated some false positives (links that appear broken but function correctly). I'm still exploring the tool's functionality to potentially fine-tune its accuracy.

On a separate note, I encountered a permissions issue when trying to open new issues.

I hope this helps

[rupali-codes]

@JuanPabloDiaz do you wanna work on it?

[JuanPabloDiaz]

@JuanPabloDiaz do you wanna work on it?

Sure. How can I test it? I understand that GitHub actions will need to be merge to see them in action. Is there a way to test them in development @rupali-codes ?

[rupali-codes]

@JuanPabloDiaz do you wanna work on it?

Sure. How can I test it? I understand that GitHub actions will need to be merge to see them in action. Is there a way to test them in development @rupali-codes ?

Yeah, we can test them in the forked repo

[JuanPabloDiaz]

You are absolutely right lol

But does it work from any branch, or does it have to be in the main branch of the forked repo @rupali-codes ?

[JuanPabloDiaz]

You are absolutely right lol

But does it work from any branch, or does it have to be in the main branch of the forked repo @rupali-codes ?

I figured it out. It has to be in the main brand of the forked repo

[JuanPabloDiaz]

Errors in CONTRIBUTING.md [404] https://github.com/CBID2/LinksHub-my-version-/blob/main/CODE_OF_CONDUCT.md | Failed: Network error: Not Found [404] https://github.com/rupali-codes/LinksHub/blob/maintainers_info/README.md#maintainers- | Failed: Network error: Not Found

[JuanPabloDiaz]

71? That number seems low.

I include JSON files in the link checker and the number went up to: https://github.com/JuanPabloDiaz/LinksHub/actions/runs/9306836967

[JuanPabloDiaz]

There are some false positive. After double checking the list of 29 errors. Here are some resources that should be removed:

1. Errors in database/resources/e-book.json "name": "Learning REACT" [404] https://drive.google.com/file/d/1AZwshgVyazeIJ95ng6Pg1zUbVQoYX93t/view?usp=share_link | Failed: Network error: Not Found

2. Errors in database/youtube/web-development.json "name": "Easy Tutorials" [404] https://www.youtube.com/@EasyTutorialsVideo/ | Failed: Network error: Not Found

3. Errors in database/ai_tools/design.json "name": "Adobe Firefly" [TIMEOUT] https://www.adobe.com/in/products/firefly.html | Timeout "name": "Designs.ai", [ERR] https://designs.io/ | Failed: Network error: error sending request for url (https://designs.io/)

4. Errors in database/youtube/web3-metaverse.json "name": "LearnWeb3 DAO" [404] https://www.youtube.com/@LearnWeb3DAO | Failed: Network error: Not Found

5. Errors in database/frontend/colors.json "name": "ColorWave AI" [ERR] https://www.colorwave.dev/ | Failed: Network error: error sending request for url (https://www.colorwave.dev/) "name": "UI Color Picker" [ERR] https://uicolorpicker.com/ | Failed: Network error: error sending request for url (https://uicolorpicker.com/)

6. Errors in database/resources/blogs.json "name": "JavaScript Tricks-Raj's Blog" [ERR] https://resourcegallery.live/blog/JavaScript%20Top%2010%20Tips%20&%20Tricks/ | Failed: Network error: error sending request for url (https://resourcegallery.live/blog/JavaScript%20Top%2010%20Tips%20&%20Tricks/)

7. Errors in database/cybersecurity/web_application_security.json "name": "Certified Web Application Penetration Tester (CWAPT) Certification" [404] https://mile2.com/web-application-penetration-tester-cwapt.html | Failed: Network error: Not Found

[CBID2]

You are absolutely right lol

But does it work from any branch, or does it have to be in the main branch of the forked repo @rupali-codes ?

It would be best to do it from the forked repository.

[JuanPabloDiaz]

May I have additional support here. I am not an expert with GitHub actions. How can I improve my workflow?