allyhawkins
commented
5 days ago Edit: One additional question I have is whether we actually don't want the links action to be required to pass before merging into main. During docs development, we may actually expect some #STUB_LINKS. We don't necessarily want that to hold up merging into a feature branch like reproducibility-docs, but we definitely don't want bad links going into main. I don't have the permissions to make this change though, so if we want to make it we can tag in someone else who can add that protection rule.
I would agree that we don't want things that are broken being merged into main, so I would keep the check there. I think if you want to make the check run but don't require it to pass on feature branches then we do need to tag in someone to update branch protection. I assume it's turned on for reproducibility-docs given merging being blocked here, so maybe we adjust to run the CI but it doesn't have to pass CI until it is merged into main?
sjspielman
I recently updated my local version of
material-mkdocs, and found that this updated version flags bad anchor links which had not been flagged previously. After playing around with this a bit in the now-closed #545, I realized that in addition to bumpingmkdocs-material, I also needed to update thecheck-links.ymlGHA itself to also grab anchor link warning messages. This GHA indeed failed as expected: https://github.com/AlexsLemonade/OpenScPCA-analysis/actions/runs/9683208495/job/26718098940This PR takes care of all these items:
mkdocs-materialandmkdocsversions to versions that I know actually tell you about bad anchor linksmkdocs-materialpatch version here?Edit: One additional question I have is whether we actually don't want the links action to be required to pass before merging into
main. During docs development, we may actually expect some#STUB_LINKS. We don't necessarily want that to hold up merging into a feature branch likereproducibility-docs, but we definitely don't want bad links going intomain. I don't have the permissions to make this change though, so if we want to make it we can tag in someone else who can add that protection rule.