Skip to content

ci: replace unmaintained markdown link checker #15424

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.

Sign up for GitHub

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 7, 2024
Merged

ci: replace unmaintained markdown link checker #15424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/.linkspector.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
dirs:
- docs
ignorePatterns:
- pattern: "://localhost"
- pattern: '://.*.?example\\.com'
- pattern: "github.com/<your_github_handle>"
- pattern: "mailto:"
aliveStatusCodes:
- 200
35 changes: 0 additions & 35 deletions .github/workflows/mlc_config.json
View file
Open in desktop

This file was deleted.

10 changes: 4 additions & 6 deletions .github/workflows/weekly-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,13 @@ jobs:
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1

- name: Check Markdown links
uses: gaurav-nelson/github-action-markdown-link-check@d53a906aa6b22b8979d33bc86170567e619495ec # v1.0.15
uses: umbrelladocs/action-linkspector@fc382e19892aca958e189954912fe379a8df270c # v1.2.4
id: markdown-link-check
# checks all markdown files from /docs including all subfolders
with:
use-quiet-mode: "yes"
use-verbose-mode: "yes"
config-file: ".github/workflows/mlc_config.json"
folder-path: "docs/"
file-path: "./README.md"
reporter: github-pr-review
config_file: ".github/.linkspector.yml"
fail_on_error: "true"

- name: Send Slack notification
if: failure() && github.event_name == 'schedule'
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/integrations/jfrog-xray.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ using Coder's [JFrog Xray Integration](https://github.com/coder/coder-xray).
[permission](https://jfrog.com/help/r/jfrog-platform-administration-documentation/permissions)
for the repositories you want to scan.
1. Create a Coder [token](../../reference/cli/tokens_create.md#tokens-create)
with a user that has the [`owner`](../users#roles) role.
with a user that has the [`owner`](../users/index.md#roles) role.
1. Create Kubernetes secrets for the JFrog Xray and Coder tokens.

```bash
Expand Down
Loading