Add linkspector config to fix local links issue

[sbland]

Description

Fixes an issue with linkspector failing local links. See #533 (comment)

Type of change

• Documentation (non-breaking change that adds or improves the documentation)
• New feature (non-breaking change which adds functionality)
• Optimization (non-breaking, back-end change that speeds up the code)
• Technical work (non-breaking, change which is work as part of a new feature)
• Bug fix (non-breaking change which fixes an issue)
• Breaking change (whatever its nature)

Key checklist

• All tests pass (eg. python -m pytest)
• The documentation builds and looks OK (eg. mkdocs serve)
• Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[AdrianDAlessandro]

I just approved this, but it seems like it's not needed anymore because the PR that this was designed to fix is no longer failing

[sbland]

I still get a failed report when I run Linkspector locally with the default config. It's possible the action has a different default which I'll check

[AdrianDAlessandro]

I still get a failed report when I run Linkspector locally with the default config. It's possible the action has a different default which I'll check

Oh right! I haven't tried to run it locally. Which links are failing when you run it locally?

[sbland]

I still get a failed report when I run Linkspector locally with the default config. It's possible the action has a different default which I'll check

Oh right! I haven't tried to run it locally. Which links are failing when you run it locally?

I used the following command:
docker run --rm -it -v $PWD:/app umbrelladocs/linkspector bash -c 'linkspector check -c /app/.linkspector.yml'

Then I get the output below:

  ❯ Linkspector v0.5.5
  ────────────────────────────────────────────

  README.md
  L118:30  ✘ http://127.0.0.1:8000/  null net::ERR_CONNECTION_REFUSED at http://127.0.0.1:8000/

  ✔ 62 OK  ✘ 3 broken  ◉ 0 skipped  ─  20 files in 9.9s

  ✘ Some hyperlinks are invalid.

[AdrianDAlessandro]

Ok @sbland I think you've uncovered a bug here. I don't think the linkspector action is working. I've just added a link that should make it fail, but it looks like it has not failed. So there is another issue here.

[sbland]

Issue seems to be that the action isn't loading the config and we are missing the line:
fail_level: any

[AdrianDAlessandro]

@sbland I've managed to work all of this out.

On localhost failing locally but not in CI:

• For some reason, the Linkspector CI action respects the markdown-link-check comments, but the way you are running it locally does not (see check failing in commit 9555a2e)
• For consistency, I think the config file approach you have put into this PR is the best approach.
• We do not need to include the config_file parameter in CI (see latest version on this branch)

On the checks appearing to pass even with invalid links:

Issue seems to be that the action isn't loading the config and we are missing the line: fail_level: any

• Yes, this fail_level is required. See the commits above, I removed and re-added all of the components to make it all make sense.