From ca825d7a6a2a33ff1a3cb802bff05b55f3a1a370 Mon Sep 17 00:00:00 2001 From: Wilken Rivera Date: Thu, 21 Apr 2022 10:15:40 -0400 Subject: [PATCH] Remove markdown link checker (#11722) The Markdown link checker currently deployed has served its purpose for the time being. It is being removed to avoid failed checks on PRs, while we evaluate alternative solutions used by other HashiCorp repositories. --- .github/workflows/linkchecker.yml | 39 -------------------- .github/workflows/scheduled-link-checker.yml | 19 ---------- .mlc_config.json | 24 ------------ 3 files changed, 82 deletions(-) delete mode 100644 .github/workflows/linkchecker.yml delete mode 100644 .github/workflows/scheduled-link-checker.yml delete mode 100644 .mlc_config.json diff --git a/.github/workflows/linkchecker.yml b/.github/workflows/linkchecker.yml deleted file mode 100644 index 2563fe57b58..00000000000 --- a/.github/workflows/linkchecker.yml +++ /dev/null @@ -1,39 +0,0 @@ -on: - pull_request: - paths: - - 'website/**' - -name: Check markdown links on modified website files -jobs: - vercel-deployment-poll: - runs-on: ubuntu-latest - timeout-minutes: 5 #cancel job if no deployment is found within x minutes - outputs: - url: ${{ steps.waitForVercelPreviewDeployment.outputs.url }} - steps: - - name: Wait for Vercel preview deployment to be ready - uses: nywilken/wait-for-vercel-preview@master - id: waitForVercelPreviewDeployment - with: - token: ${{ secrets.GITHUB_TOKEN }} - max_timeout: 600 # in seconds, set really high to leverage job timeout-minutes values - allow_inactive: true # needed to ensure we get a URL for a previously released deployment - markdown-link-check: - needs: vercel-deployment-poll - if: ${{ needs.vercel-deployment-poll.outputs.url != '' }} - runs-on: ubuntu-latest - steps: - - name: Get Deployment URL - run: - echo "DEPLOYMENT_URL=${{ needs.vercel-deployment-poll.outputs.url }}" >> $GITHUB_ENV - - name: Checkout source branch - uses: actions/checkout@master - - name: Check links - uses: gaurav-nelson/github-action-markdown-link-check@v1 - with: - use-quiet-mode: 'yes' - file-extension: 'mdx' - check-modified-files-only: 'yes' - folder-path: 'website/content' - base-branch: 'main' - config-file: '.mlc_config.json' diff --git a/.github/workflows/scheduled-link-checker.yml b/.github/workflows/scheduled-link-checker.yml deleted file mode 100644 index 5bd5b517d40..00000000000 --- a/.github/workflows/scheduled-link-checker.yml +++ /dev/null @@ -1,19 +0,0 @@ -on: - schedule: - - cron: "45 0 * * *" -name: Check Markdown links on main branch -jobs: - markdown-link-check: - runs-on: ubuntu-latest - steps: - - name: Set deployment URL env - run: - echo "DEPLOYMENT_URL=https://packer-git-main.hashicorp.vercel.app" >> $GITHUB_ENV - - uses: actions/checkout@master - - uses: gaurav-nelson/github-action-markdown-link-check@v1 - with: - use-quiet-mode: 'yes' - file-extension: 'mdx' - folder-path: 'website/content' - base-branch: 'main' - config-file: '.mlc_config.json' diff --git a/.mlc_config.json b/.mlc_config.json deleted file mode 100644 index 53dabc0fb7c..00000000000 --- a/.mlc_config.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "ignorePatterns": [ - { - "pattern": "^https://example.com" - }, - { - "pattern": "^https://ec2.custom.endpoint.com" - }, - { - "pattern": "^https://www.linode.com" - }, - { - "pattern": "^https://oidref.com/" - } - ], - "replacementPatterns": [ - { - "pattern": "^/", - "replacement": "{{env.DEPLOYMENT_URL}}/" - } - ], - "timeout": "20s", - "retryOn429": true -}