Broken Link Checker - Github Action

[JuanPabloDiaz]

• Check links [Feature] Broken Link Checker - Github Action #2357

Fixes Issue

Closes #2357

Changes proposed

JuanPabloDiaz#39

Screenshots

Note to reviewers

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
linkshub	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 5, 2024 9:20pm

[github-actions]

Thank you, JuanPabloDiaz, for creating this pull request and contributing to LinksHub! 💗

The maintainers will review this Pull Request and provide feedback as soon as possible! 😇
We appreciate your patience and contribution, Keep up the great work! 😀

[rupali-codes]

@Anmol-Baranwal @CBID2 could you please review it

[CBID2]

Looks good to me. What do you think @Anmol-Baranwal?

[JuanPabloDiaz]

After completing the pull request, I realized it would be beneficial to extend the functionality by running the workflow whenever a pull request is opened to check the URLs as well. This feature is likely already configured in my workflow, but I haven't found a way to test it yet.

[Anmol-Baranwal]

After completing the pull request, I realized it would be beneficial to extend the functionality by running the workflow whenever a pull request is opened to check the URLs as well. This feature is likely already configured in my workflow, but I haven't found a way to test it yet.

I want a clear overview of how it works and what exactly you are trying to do.

Will it open a PR if there are broken URLs in the repo? What exactly will happen? Just let me know so I can check the docs and necessary links to help.

[JuanPabloDiaz]

Sure @Anmol-Baranwal,

This workflow is designed to automatically check for broken links in Markdown and JSON files within the repository. It runs under several conditions: 1. on pull requests to the 'main' branch, 2. on pushes to the 'main' branch, 3. on manual triggers, and 4. on a scheduled basis (every Monday at 12:30 UTC). If any broken links are found, the workflow creates or updates a GitHub issue with the details.

[JuanPabloDiaz]

In addition...

Link Checker:

The Link Checker step reads the .lycheeignore file specified by the --exclude-file .lycheeignore argument to determine which links or files should be excluded from the link checking process.

What Happens if Broken Links are Found

If broken links are detected during any of the trigger events, the workflow will:

1. Check if there is an existing open issue with the label automated-link-issue.
2. If an existing issue is found, it will update this issue with the details of the broken links.
3. If no existing issue is found, it will create a new issue with the details of the broken links.
4. The issue will be labeled with automated-link-issue, broken-link, and docs for easy identification and tracking.

[Anmol-Baranwal]

@JuanPabloDiaz
Thank you! I will check the docs and necessary workflows in a day or two.

[JuanPabloDiaz]

@Anmol-Baranwal, I found a simpler workflow that we could use instead (it is clean and easy to understand). I test it in one of my projects and it does the job.

[Anmol-Baranwal]

Sure. I will check it out.

Let's proceed with this one then.

[Anmol-Baranwal]

@rupali-codes
New workflow seems better. I think it's safe to proceed.

Let's merge this quick!