feat: check links via linkinator

[mshanemc]

check markdown files for broken links

1. top-level of the project that are not CHANGELOG.md
2. and everything in /messages

@W-14543815@

[mshanemc]

different glob implementations. the command uses ! to get everything that isn't the changelog.

the files in wireit uses the ! to exclude thing included by the previous globs.

[iowillhoit]

I was playing around with this a bit. We are missing some files with this current pattern. What do you think about this:

"command": "linkinator \"**/*.md\" --skip 'CHANGELOG.md|node_modules|^test|confluence.internal.salesforce.com' --markdown --retry --directory-listing --verbosity error",

This finds an additional 20 links in forcedotcom/source-deploy-retrieve (from 50 to 70). We can add additional "skips" as we find them

[mshanemc]

commit that!

[iowillhoit]

I wonder if we should come up with a way to skip this if needed. Maybe with an environment variable? I am imagining this exiting on a false positives (website down) and preventing a release. You could force merge a PR but you would not have any NUTs run if the unit tests failed because of linkinator. Example GHA

[mshanemc]

I wonder if we should come up with a way to skip this if needed. Maybe with an environment variable? I am imagining this exiting on a false positives (website down) and preventing a release. You could force merge a PR but you would not have any NUTs run if the unit tests failed because of linkinator. Example GHA

Yeah, so the GHA could read from GHA variables to skip itself? Good idea, commit that, too.

[iowillhoit]

Ok @mshanemc this is ready for you to take a look at. I made a couple more changes to this.

• Changed ^test to test/. Despite what their docs say, I could not get this regex to work.
  • The downside of this is that it will also skip nested test directories. For example messages/test/foo.md
• Added %s like we use in plugin-info
• Added link-check to the scripts so you can run it on its own
• Added a cross-os way of skipping the link-check. See screenshot

[iowillhoit]

Hold up a bit on this, the env var is not working in CI. Trying a couple things.