From 45c1cf6a62c0500c4b0d960b01b068973100752b Mon Sep 17 00:00:00 2001 From: Ethan Dickson Date: Thu, 7 Nov 2024 10:30:56 +0000 Subject: [PATCH] ci: replace unmaintained markdown link checker --- .github/.linkspector.yml | 9 +++++++ .github/workflows/mlc_config.json | 35 --------------------------- .github/workflows/weekly-docs.yaml | 10 +++----- docs/admin/integrations/jfrog-xray.md | 2 +- 4 files changed, 14 insertions(+), 42 deletions(-) create mode 100644 .github/.linkspector.yml delete mode 100644 .github/workflows/mlc_config.json diff --git a/.github/.linkspector.yml b/.github/.linkspector.yml new file mode 100644 index 0000000000000..b24df8940f608 --- /dev/null +++ b/.github/.linkspector.yml @@ -0,0 +1,9 @@ +dirs: + - docs +ignorePatterns: + - pattern: "://localhost" + - pattern: '://.*.?example\\.com' + - pattern: "github.com/" + - pattern: "mailto:" +aliveStatusCodes: + - 200 diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json deleted file mode 100644 index e7c4c6c1a3f27..0000000000000 --- a/.github/workflows/mlc_config.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "ignorePatterns": [ - { - "pattern": "://localhost" - }, - { - "pattern": "://.*.?example\\.com" - }, - { - "pattern": "developer.github.com" - }, - { - "pattern": "docs.github.com" - }, - { - "pattern": "github.com/" - }, - { - "pattern": "imgur.com" - }, - { - "pattern": "support.google.com" - }, - { - "pattern": "mailto:" - }, - { - "pattern": "tailscale.com" - }, - { - "pattern": "wireguard.com" - } - ], - "aliveStatusCodes": [200, 0] -} diff --git a/.github/workflows/weekly-docs.yaml b/.github/workflows/weekly-docs.yaml index 668a75833167a..ad2db344b2500 100644 --- a/.github/workflows/weekly-docs.yaml +++ b/.github/workflows/weekly-docs.yaml @@ -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' diff --git a/docs/admin/integrations/jfrog-xray.md b/docs/admin/integrations/jfrog-xray.md index d0a6fae5c4f7b..933bf2e475edd 100644 --- a/docs/admin/integrations/jfrog-xray.md +++ b/docs/admin/integrations/jfrog-xray.md @@ -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