From 96559ce593ceb920d24727812ff10bd80ab77d9f Mon Sep 17 00:00:00 2001 From: Aimee Ukasick Date: Fri, 5 Mar 2021 14:23:41 -0600 Subject: [PATCH] docs(linkcheck): use HTMLTEST instead Use HTMLTEST for checking links since it we need to check generated HTML files. The current link checker only checks markdown files, so internal links done with shortcodes aren't checked. [DOC-320] --- .github/workflows/html-link-checker.yml | 26 ++++++++++++++++++++++++ .github/workflows/mlc_config.json | 25 ----------------------- .github/workflows/pr-link-check.yml | 22 -------------------- .github/workflows/sched-link-checker.yml | 17 ---------------- .github/workflows/vale.yml | 10 +++++++-- .htmltest.yml | 13 ++++++++++++ 6 files changed, 47 insertions(+), 66 deletions(-) create mode 100644 .github/workflows/html-link-checker.yml delete mode 100644 .github/workflows/mlc_config.json delete mode 100644 .github/workflows/pr-link-check.yml delete mode 100644 .github/workflows/sched-link-checker.yml create mode 100644 .htmltest.yml diff --git a/.github/workflows/html-link-checker.yml b/.github/workflows/html-link-checker.yml new file mode 100644 index 0000000000..7e98e5eb24 --- /dev/null +++ b/.github/workflows/html-link-checker.yml @@ -0,0 +1,26 @@ +name: HTMLTEST + +# Run this workflow every time a new commit pushed to your repository +on: pull_request + +jobs: + # Set the job key. The key is displayed as the job name + # when a job name is not provided + htmltest: + # Name the Job + name: Run HTMLTEST link checker + # Set the type of machine to run on + runs-on: ubuntu-latest + + steps: + # Checks out a copy of your repository on the ubuntu-latest machine + - name: Checkout code + uses: actions/checkout@master + + # Runs the HTMLTEST action + - name: Run HTMLTEST + uses: wjdp/htmltest-action@master + with: + config: .htmltest.yml + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json deleted file mode 100644 index f46b753dd8..0000000000 --- a/.github/workflows/mlc_config.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "ignorePatterns": [ - { - "pattern": "/^images/(*.*)" - }, - { - "pattern": "/^Images/(*.*)" - }, - { - "pattern": "^http://localhost:9000" - }, - { - "pattern": "^http://gate.org.com:8084" - }, - { - "pattern": "^http://demo.armory.io" - }, - { - "pattern": "^https://github.com/organizations/your_org_here/settings/hooks" - }, - { - "pattern": "^http://opa.opaserver:8181" - } - ] -} diff --git a/.github/workflows/pr-link-check.yml b/.github/workflows/pr-link-check.yml deleted file mode 100644 index 5c25a452b4..0000000000 --- a/.github/workflows/pr-link-check.yml +++ /dev/null @@ -1,22 +0,0 @@ -# This is a basic workflow to help you get started with Actions -# https://github.com/marketplace/actions/markdown-link-check - -name: Check links in modified files - -# Controls when the action will run. Triggers the workflow on push or pull request -# events but only for the master branch -on: pull_request -jobs: - markdown-link-check: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - with: - fetch-depth: 1 - - uses: gaurav-nelson/github-action-markdown-link-check@1.0.7 - with: - use-quiet-mode: 'yes' # Specify yes to only show errors in output.# - use-verbose-mode: 'yes' # Specify yes to show detailed HTTP status for checked links.# - check-modified-files-only: 'yes' # Use this variable to only check modified markdown files instead of checking all markdown files. # - config-file: './.github/workflows/mlc_config.json' - max-depth: 1 diff --git a/.github/workflows/sched-link-checker.yml b/.github/workflows/sched-link-checker.yml deleted file mode 100644 index eca697e056..0000000000 --- a/.github/workflows/sched-link-checker.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: Check Site links 9AM - -on: - schedule: - # Run everyday at 9:00 AM (See https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07) - - cron: "0 9 * * *" - -jobs: - markdown-link-check: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - uses: gaurav-nelson/github-action-markdown-link-check@1.0.7 - with: - use-quiet-mode: 'yes' - use-verbose-mode: 'yes' - config-file: './.github/workflows/mlc_config.json' diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index 5290b273de..231c5960e4 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -12,14 +12,20 @@ jobs: uses: errata-ai/vale-action@master with: # Optional - styles: + styles: https://github.com/errata-ai/Google/releases/latest/download/Google.zip # Optional. Only lint modified files. Once we pay off tech debt, we'll switch the linting to onlyAnnotateModifiedLines afterwards files: __onlyModified - + # only annotate lines that have been modified within a PR onlyAnnotateModifiedLines: true env: # Required GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + + - name: HTMLTEST + uses: wjdp/htmltest-action@master + with: + config: .htmltest.yml + diff --git a/.htmltest.yml b/.htmltest.yml new file mode 100644 index 0000000000..14e30d1165 --- /dev/null +++ b/.htmltest.yml @@ -0,0 +1,13 @@ +DirectoryPath: public/docs +CheckExternal: false +IgnoreAltMissing: true +CheckImages: false +CheckScripts: false +CheckMeta: false +CheckMetaRefresh: false +CheckLinks: false +EnforceHTML5: false +EnforceHTTPS: false +IgnoreDirectoryMissingTrailingSlash: false +IgnoreInternalEmptyHash: true +IgnoreEmptyHref: true \ No newline at end of file