GH Actions Link Checker? #66
Comments
|
I have thought about that for a bit. We could just run it locally, or figure out the action. I don't think it would interact weirdly with the current awesome lint checks. Only one way to find out. |
|
I hit syntax errors in 34dbb30. Looks like more work to figure it out. I can figure out how to do a job with clear example, but this might require digging in more. I think we should run this locally once a year or something. A python library exists too here. https://pypi.org/project/LinkChecker/ |
|
For the time being, I picked a quick tool to do this. You were 100% right, we need to check links occasionally, ideally on commit. I remember now this is a common problem in the community (apparently 14% of awesome links are typically dead). The issues on this have some solutions worth trying out. I will give them a shot. I am worried we might get some "over-counting" as some of the links that get flagged don't have an issue. Report out is as follows: ResultsList of broken links and other issuesThere are issues with the URLs listed below. The table summarizes the issues and suggested actions by HTTP response status code.
List of redirectsThe links below are not broken, but the document does not use the exact URL, and the links were redirected. It may be a good idea to link to the final location, for the sake of speed.
Code Occurrences What to do error Line: 1696 https://www.fws.gov/wetlands/index.html error Line: 1808 https://www.safegraph.com/ error Lines: 1164, 1206 https://github.com/APA-Technology-Division/urban-and-regional-planning-resources/blob/%7B%7B%20urlEncodedRefName%20%7D%7D/README.md error Line: 2029 https://www.gigitheplanner.com/podcast error Line: 1759 https://ctpp.transportation.org/ error Line: 1999 https://www.planning.org/certification/register/ Broken fragments: Broken fragments: Broken fragments: Broken fragments: info Line: 1764 https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/E5TPDQ info Line: 2059 https://docs.google.com/forms/d/e/1FAIpQLSfGp_XC5V-uIzafsVBhR4xKX9YhgNOz22w84Sg0zo0ONDdV4w/viewform?usp=sf_link info Line: 1706 https://www.policymap.com/newmaps Broken fragments: info Line: 1668 https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2021EF002016 info Line: 2049 https://dataverse.harvard.edu/ warning Line: 1760 https://www.fhwa.dot.gov/policyinformation/hpms.cfm0 error Line: 1742 https://openprecincts.org/ error Line: 1752 https://www.adaptationclearinghouse.org/ error Line: 1665 https://www.ncdc.noaa.gov/severe-weather/severe-weather-data-inventory List of redirects warning Line: 1947 https://www.bangthetable.com/ redirected to https://granicus.com/solution/govdelivery/engagementhq/?utm_campaign=btt_redirect&utm_medium=referral&utm_source=bangthetable warning Line: 1775 https://www.esri.com/en-us/arcgis/products/tapestry-segmentation/zip-lookup redirected to https://www.esri.com/en-us/arcgis/products/data/overview?rsource=https%3A%2F%2Fwww.esri.com%2Fen-us%2Farcgis%2Fproducts%2Ftapestry-segmentation%2Fzip-lookup#data-demo warning Line: 2061 https://github.com/APA-Technology-Division/planning-technology-resources/blob/main/CONTRIBUTING.md redirected to https://github.com/APA-Technology-Division/urban-and-regional-planning-resources/blob/main/CONTRIBUTING.md warning Line: 1842 https://github.com/NABSA/gbfs redirected to https://github.com/MobilityData/gbfs warning Line: 1556 https://github.com/APA-Technology-Division/planning-technology-resources redirected to https://github.com/APA-Technology-Division/urban-and-regional-planning-resources warning Line: 2122 https://docs.github.com/en/github/site-policy/github-privacy-statement redirected to https://docs.github.com/en/site-policy/privacy-policies/github-privacy-statement warning Line: 2048 https://www.data.gov/ redirected to https://data.gov/ warning Line: 2129 https://services.github.com/ redirected to https://github.com/services/ warning Line: 1835 https://www.github.com/sharedstreets/curblr redirected to https://github.com/curblr/curblr-spec warning Line: 1923 https://livingatlas.arcgis.com/assessment-tool/home redirected to https://livingatlas.arcgis.com/assessment-tool/home/ warning Line: 1555 https://github.com/APA-Technology-Division/planning-technology-resources/stargazers redirected to https://github.com/APA-Technology-Division/urban-and-regional-planning-resources/stargazers warning Line: 2038 https://github.com/NABSA/micromobility-tools-and-resources redirected to https://github.com/MobilityData/gbfs-tools-and-resources warning Line: 2063 https://github.com/NABSA/micromobility-tools-and-resources/blob/master/README.md redirected to https://github.com/MobilityData/gbfs-tools-and-resources/blob/master/README.md warning Line: 1559 https://github.com/APA-Technology-Division/planning-technology-resources/blob/main/LICENSE redirected to https://github.com/APA-Technology-Division/urban-and-regional-planning-resources/blob/main/LICENSE warning Line: 1761 https://transit.land/ redirected to https://www.transit.land/ warning Line: 1954 https://www.maptionnaire.com/ redirected to https://maptionnaire.com/ warning Line: 1807 https://replicahq.com/platform redirected to https://replicahq.com/platform/ warning Line: 1927 https://cityenergyanalyst.com/ redirected to https://www.cityenergyanalyst.com/ warning Line: 1695 https://www.usgs.gov/core-science-systems/ngp/national-hydrography/access-national-hydrography-products redirected to https://www.usgs.gov/national-hydrography/access-national-hydrography-products warning Line: 2121 https://docs.github.com/en/github/site-policy/github-terms-of-service redirected to https://docs.github.com/en/site-policy/github-terms/github-terms-of-service |
|
I honestly have just found YML recipes (event action sequences) into the .github/workflows. The lint checker for this was pretty well documented. I was going to try the link checker I found in that GitHub issue. I found some tutorials (documentation/youtube) on actions helpful. |
|
b208de0 - this commit seemed to get it to work. I think we just need to work through the errors. I started. Stopped for now. Link maintenance is hard, we might need to modify the config file documented here: https://github.com/tcort/markdown-link-check#config-file-format |
|
01f25ff - Going to close with this commit. The action now works and passes as expected. I had to ignore bad request errors and a few others documented in the config file here. I think this is good enough. |
Noticed that there was one link that was out of date and wondered if we might be able to use a link checker? Don't do much work that involves use of GH Actions, but wondering if thats something that might help so it didn't have to be done manually?
LINKCHECK
The text was updated successfully, but these errors were encountered: