Skip to content

ci: reenable link checker & fix broken links #15489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Conversation

ethanndickson
Copy link
Member

@ethanndickson ethanndickson commented Nov 13, 2024

Follow-up on #15484.

Copy link
Member Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @ethanndickson and the rest of your teammates on Graphite Graphite

@@ -327,8 +327,7 @@ the OIDC provider. See
> ones include `groups`, `memberOf`, and `roles`.

Next configure the Coder server to read groups from the claim name with the
[OIDC organization field](../../reference/cli/server.md#--oidc-organization-field)
server flag:
OIDC organization field server flag:
Copy link
Member Author

Choose a reason for hiding this comment

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

This CLI arg got moved to runtime config a few days ago, so it's no longer in the reference. The docs will need updating soon.

@ethanndickson ethanndickson force-pushed the ethan/fix-docs-ci branch 3 times, most recently from 2777501 to 4fd8bb0 Compare November 13, 2024 02:23
@@ -1,9 +1,19 @@
dirs:
- docs
excludedDirs:
# Downstream bug in linkspector means large markdown files fail to parse
# but these are autogenerated and shouldn't need checking
Copy link
Member Author

@ethanndickson ethanndickson Nov 13, 2024

Choose a reason for hiding this comment

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

@ethanndickson ethanndickson marked this pull request as ready for review November 13, 2024 02:41
@@ -33,6 +33,7 @@ jobs:
reporter: github-pr-review
config_file: ".github/.linkspector.yml"
fail_on_error: "true"
filter_mode: "nofilter"
Copy link
Member Author

@ethanndickson ethanndickson Nov 13, 2024

Choose a reason for hiding this comment

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

I incorrectly assumed that the weekly-docs job being started from the cron job would mean it wouldn't use the pull request changes filter, but evidently not. This means it checks the whole docs folder for the cron job & on PRs. It complained about the emacs link on this PR, even though it wasn't included in the diff, so I'm more confident that it works properly now.

Copy link
Member

Choose a reason for hiding this comment

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

So on schedule, we check the whole repo?
What does the filter_mode mean?

Copy link
Member Author

Choose a reason for hiding this comment

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

The default filter_mode was just the PR diff. Now it should be everything mentioned in the .linkspector.yml config.

@ethanndickson ethanndickson merged commit fa69d1c into main Nov 13, 2024
31 checks passed
@ethanndickson ethanndickson deleted the ethan/fix-docs-ci branch November 13, 2024 05:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants