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

Add GitHub action to check links #12

Merged
merged 2 commits into from
Jan 10, 2022

Conversation

julienloizelet
Copy link
Contributor

Hi,
this pull request add a GitHub actions to check links in the README.

This is just a check with the awesome-bot.

I tried it on my fork, and you can see the result here

There is only a 404, lot of 301 because of en ending /, some 302 and 303, and some duplicates URL (called dupes).

For the moment, I call awesome_bot README.md --skip-save-results but we could easily add other options :

  • --allow-dupe Duplicate URLs are allowed
  • --white-list [urls] Comma separated URLs to white list
  • --allow [errors] Status code errors to allow
  • --allow-redirect Redirected URLs are allowed

etc, etc. (please see the doc in the awesome_bot repo).

Of course, we could also change the on part of the action (I set it to push, pull_request and workflow_dispatch, but we may prefer something else)

Let me know what you think :)

Copy link
Member

@rfay rfay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, we'll give it a shot. If it ends up being too annoying (have had some trouble with link checking timeouts and such in ddev, can be a bit of work)

.github/workflows/check-links.yml Outdated Show resolved Hide resolved
@rfay rfay merged commit 222e5ef into ddev:master Jan 10, 2022
@rfay
Copy link
Member

rfay commented Jan 10, 2022

Now you can do a PR to do the fixups :) Thanks!

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.

2 participants