Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New GitHub Action - Check Broken Links #391

Merged
merged 1 commit into from
Jul 23, 2024

Conversation

JuanPabloDiaz
Copy link
Collaborator

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

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.

Fixes #354

Main Changes

  • Add Workflow
  • Add ignore file
  • Add false positive URLs to ignore file
  • Fix URL in readme
  • Delete broken links in readme
  • run tests
  • My submission is formatted according to the guidelines in the contributing guide
  • My addition is ordered alphabetically
  • My submission has a useful description
  • The description does not have more than 100 characters
  • The description does not end with punctuation
  • Each table column is padded with one space on either side
  • I have searched the repository for any relevant issues or pull requests
  • Any category I am creating has the minimum requirement of 3 items
  • All changes have been squashed into a single commit

Fixes marcelscruz#354
- Add Workflow
- Add ignore file
- Add false positive urls to ignore file
- Fix URL in readme
- Delete broken links in readme
- run tests
@JuanPabloDiaz
Copy link
Collaborator Author

JuanPabloDiaz commented Jul 12, 2024

I got it down to 15 site errors. Check the results

It all yours @marcelscruz

@JuanPabloDiaz
Copy link
Collaborator Author

I found a simpler workflow that you could use instead. I test it in one of my projects and it does the job.

You might need to change the argument to check all markdown files and you are good to go.

@marcelscruz marcelscruz merged commit 572a878 into marcelscruz:main Jul 23, 2024
1 check failed
@marcelscruz
Copy link
Owner

I'm merging the one you created to see how it works, then if needed I'll update the workflow.
Thank you so much, Juan!

@JuanPabloDiaz
Copy link
Collaborator Author

I'm merging the one you created to see how it works, then if needed I'll update the workflow. Thank you so much, Juan!

You're welcome @marcelscruz

@JuanPabloDiaz JuanPabloDiaz deleted the PR-Links branch July 23, 2024 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken Link Checker - Github Action
2 participants