diff --git a/.github/workflows/check-md.yml b/.github/workflows/check-md.yml new file mode 100644 index 0000000000..59a3ffefc4 --- /dev/null +++ b/.github/workflows/check-md.yml @@ -0,0 +1,19 @@ +name: Check Markdown links + +on: + pull_request: + branches: + - main + - 'release/*' + +jobs: + markdown-link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + config-file: '.github/workflows/markdown.links.config.json' + check-modified-files-only: 'no' # TODO: set to 'yes' before merging + use-verbose-mode: 'yes' + use-quiet-mode: 'yes' diff --git a/.github/workflows/markdown.links.config.json b/.github/workflows/markdown.links.config.json new file mode 100644 index 0000000000..e89109c6df --- /dev/null +++ b/.github/workflows/markdown.links.config.json @@ -0,0 +1,7 @@ +{ + "ignorePatterns": [ + { + "pattern": "^https://dummy-website.com" + } + ] +} diff --git a/tools/github-actions/download-build-output/readme.md b/tools/github-actions/download-build-output/readme.md index ffb929fcb5..c4873c4945 100644 --- a/tools/github-actions/download-build-output/readme.md +++ b/tools/github-actions/download-build-output/readme.md @@ -4,7 +4,7 @@ Download and restore the `dist` folders from GitHub artifact (check [Upload build output](../upload-build-output/readme.md)) ## Task options -See [Action specifications](tools/github-actions/download-build-output/action.yml) directly for more information about the supported parameters. +See [Action specifications](./action.yml) directly for more information about the supported parameters. ## Usage example ```yaml diff --git a/tools/github-actions/setup/readme.md b/tools/github-actions/setup/readme.md index 1a7be2a101..32e7c62d53 100644 --- a/tools/github-actions/setup/readme.md +++ b/tools/github-actions/setup/readme.md @@ -9,7 +9,7 @@ Including : ## Task options -See [Action specifications](tools/github-actions/setup/action.yml) directly for more information about the supported parameters. +See [Action specifications](./action.yml) directly for more information about the supported parameters. ## Usage example diff --git a/tools/github-actions/upload-build-output/readme.md b/tools/github-actions/upload-build-output/readme.md index 19c3f3aeed..b2336d1886 100644 --- a/tools/github-actions/upload-build-output/readme.md +++ b/tools/github-actions/upload-build-output/readme.md @@ -8,7 +8,7 @@ You can then use the download build output action for the download (check [Downl ## Task options -See [Action specifications](tools/github-actions/upload-build-output/action.yml) directly for more information about the supported parameters. +See [Action specifications](./action.yml) directly for more information about the supported parameters. ## Usage example