Skip to content
This repository has been archived by the owner on Dec 7, 2023. It is now read-only.

link-checking: Ignore /pkg/apis links, auto-generated docs #619

Closed
wants to merge 2 commits into from
Closed

link-checking: Ignore /pkg/apis links, auto-generated docs #619

wants to merge 2 commits into from

Conversation

dholbach
Copy link
Contributor

  • Update theme version as well.

Closes: #618

@@ -45,7 +45,7 @@ jobs:
id: lc2
uses: peter-evans/link-checker@v1
with:
args: -d site/ -r site/ -x "(github.com/weaveworks/ignite($|/issue|/pull|/releases|/commit/|/releases)|squidfunk.github.io|ignite.readthedocs.io)"
args: -d site/ -r site/ -x "(github.com/weaveworks/ignite($|/issue|/pull|/releases|/commit/|/releases|/tree/master/pkg/apis)|squidfunk.github.io|ignite.readthedocs.io)"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checking /tree/master actually caught a valid error in the docs.
See commit: c53a6a4

Fails on master because we did not remove v1alpha1 API docs when we deprecated the API

Solution to the valid link-checking error was PR: #625

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So should I close this PR? The theme update is not strictly necessary.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dholbach hi, we had a discussion about this in the weekly meeting. We agreed that it's useful to run the link checks on the master branch only and we should disable the checks on the PR.
Can you update this PR to keep the theme update and update the github workflow for check-links to not run on pull requests?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merged #656

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Link checking of ./site hits too many Github URLs
3 participants