Markdown link checker can't handle the case where Dockerfiles are added or moved

dotnet / dotnet-docker

Docker images for .NET and the .NET Tools.

https://hub.docker.com/_/microsoft-dotnet

MIT License

4.48k stars 1.94k forks source link

Markdown link checker can't handle the case where Dockerfiles are added or moved #5871

Closed lbussell closed 3 weeks ago

lbussell commented 2 months ago

The auto-generated tags tables contain absolute links to the individual Dockerfiles for each image.

If you submit a PR that moves Dockerfiles like this one, then the link checker will always fail since the links are not live yet (the PR has not been merged and the files don't exist).

Related: #5818 /cc @MichaelSimons

lbussell commented 1 month ago

[Triage]

Some potential solution ideas:

Use relative links in tags tables since the tags table is no longer posted to DockerHub
Accept merging on red
Only run the markdown link checker on a schedule so that it only checks the live markdown files.

Of these, the first seems the most promising. It would still fail when adding new Docker repos, but that is infrequent enough that it's not a big issue.

lbussell commented 3 weeks ago

[Triage] This was fixed with a change to ImageBuilder tags table generation: https://github.com/dotnet/docker-tools/pull/1446