Github action using the url-test library to find broken links in code and docs. The goal with this Github Action it to allow for integrating test to find broke links as part of your CI/CD pipelines.
Example github workflow using url-test-github-action :
jobs:
test_job:
runs-on: ubuntu-latest
name: Test action
steps:
- name: checkout files in repo
uses: actions/checkout@master
- name: Check broken links
uses: JohanWork/[email protected]
with:
file-types: '.md'in the example only files ending with .md will be tested. If any broken links are found the test will break after reporting all links found which are broken.
Two working examples can be found here:
- Implement in go to improve speed and developer experience
- Relative imports between
.mdfiles