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

Markdown link check has an issue with some links even though they work fine #5872

Closed
lbussell opened this issue Sep 10, 2024 · 5 comments · Fixed by #5925
Closed

Markdown link check has an issue with some links even though they work fine #5872

lbussell opened this issue Sep 10, 2024 · 5 comments · Fixed by #5925

Comments

@lbussell
Copy link
Contributor

I have noticed that the markdown link check Github action has issues with certain links, even though the links work correctly.

Both of the links Work On My Machine. This has been causing many valid PRs to appear as failing validation. I believe that retries have caused some of these to pass but I cannot confirm that.

Related: #5818
/cc @MichaelSimons

@lbussell
Copy link
Contributor Author

lbussell commented Sep 16, 2024

[Triage] There are configuration options that we could use here:

  1. Only enable Markdown checking on files that are modified in a PR
    • If so, then run against all files separately on a schedule
  2. Increase the number of automatic retries, or retry on more/different error codes
  3. Allow-list certain links to prevent them from being checked if we know they work (e.g. https://support.microsoft.com/contactus/)

@MichaelSimons
Copy link
Member

Another issue I just noticed is 429s when validating the Docker Hub links 😞.

@lbussell
Copy link
Contributor Author

Another issue I just noticed is 429s when validating the Docker Hub links 😞.

[Triage] Instead of the GitHub READMEs pointing to DockerHub repos, we should make them point to the other GitHub READMEs instead. Since there's no extra content on DH that isn't in our GH readmes, there's not much point in linking there from here. That would remove this entire class of issues.

@lbussell
Copy link
Contributor Author

[Triage] The original issue described in the post was resolved with #5892, so this can be closed. Any additional work should be filed as a separate issue.

@lbussell
Copy link
Contributor Author

I found several more instances of this, all on microsoft.com links:

https://learn.microsoft.com/powershell/scripting/install/installing-powershell-on-linux

ERROR: 1 dead links found!
[✖] https://learn.microsoft.com/powershell/scripting/install/installing-powershell-on-linux → Status: 0

https://docs.microsoft.com/virtualization/windowscontainers/images-eula

ERROR: 1 dead links found!
[✖] https://docs.microsoft.com/virtualization/windowscontainers/images-eula → Status: 0

https://learn.microsoft.com/dotnet/core/deploying/ready-to-run

ERROR: 1 dead links found!
[✖] https://learn.microsoft.com/dotnet/core/deploying/ready-to-run → Status: 0

https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.storelocation

ERROR: 1 dead links found!
[✖] https://learn.microsoft.com/dotnet/api/system.security.cryptography.x509certificates.storelocation → Status: 0

The author of the markdown link checker recommends their new project, UmbrellaDocs/action-linkspector, instead. Development has stopped on the current markdown link checker (source). Of note, the new checker does support running as a Docker image.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants