diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index e3bafccb2..159fd0fda 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -3,23 +3,25 @@ on: push: branches: - main - - single-tech/databricks pull_request: branches: - main - - single-tech/databricks jobs: - markdown-link-check: + check-links: + name: runner / linkspector runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write steps: - - uses: actions/checkout@v2 - - uses: gaurav-nelson/github-action-markdown-link-check@v1 + - uses: actions/checkout@v4 + - name: Run linkspector + uses: umbrelladocs/action-linkspector@v1 with: - use-quiet-mode: 'yes' - use-verbose-mode: 'yes' - config-file: '.markdownlinkcheck.json' - file-extension: '.md' + reporter: github-pr-review + fail_on_error: true + config_file: '.linkspector.yml' markdown-lint: runs-on: ubuntu-latest steps: diff --git a/.github/workflows/yaml.yml b/.github/workflows/yaml.yml index 6618bd5e8..1f5c9be3e 100644 --- a/.github/workflows/yaml.yml +++ b/.github/workflows/yaml.yml @@ -3,11 +3,9 @@ on: push: branches: - main - - single-tech/databricks pull_request: branches: - main - - single-tech/databricks jobs: yml-lint: diff --git a/.markdownlinkcheck.json b/.markdownlinkcheck.json deleted file mode 100644 index b90893ad6..000000000 --- a/.markdownlinkcheck.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "ignorePatterns": [ - { - "pattern": "^https://data.melbourne.vic.gov.au/resource/" - }, - { - "pattern": "^https://adb-[0-9]+.[0-9].azuredatabricks.net" - }, - { - "pattern": "^https://sigdelta.com/blog/how-to-install-pyspark-locally/" - }, - { - "pattern": "^https://stmdwpublic.blob.core.windows.net/" - }, - { - "pattern": "^https://azure.microsoft.com/en-us/free/" - }, - { - "pattern": "^https://azure.microsoft.com/en-us/products/" - }, - { - "pattern": "^https://learn.microsoft.com/azure/" - }, - { - "pattern": "^https://dev.azure.com" - } - ] -} diff --git a/linkspector.yml b/linkspector.yml new file mode 100644 index 000000000..dc41807ea --- /dev/null +++ b/linkspector.yml @@ -0,0 +1,16 @@ +files: + - README.md + - SECURITY.md +dirs: + - e2e_samples + - single_tech_samples +aliveStatusCodes: + - 200 + - 201 + - 204 +ignorePatterns: + - pattern: "^https://data.melbourne.vic.gov.au/resource/" + - pattern: "^https://adb-[0-9]+.[0-9].azuredatabricks.net" + - pattern: "^https://stmdwpublic.blob.core.windows.net/" +useGitIgnore: true +modifiedFilesOnly: false