A light link checker, no more broken link in your quality project documentation. (support only markdown)
A part of a good developer experience is to ensure that the documentation is accurate. Since most of the repositories depend on different website to get additional detail. This Github action will support you to validate all the links includes in your documentation.
The developer experience (DX) should be a part of the Product Quality Assurance
If you want to use the script on github action:
- Create a new file in your repository :
.github/workflows/markdown-lint.yml - Copy paste the informations in your
.github/workflows/markdown-lint.yml:
name: Markdown lint
on: [push]
jobs:
check-links:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: 'restqa-404-links'
uses: restqa/404-links@2.2.0
In order to customize the linter, you will need to create a .404-links.yml configuration file at the root level of your project.
Then you can add the following options into the file:
folder: docs/ # The folder that required to be parsed
ignore:
urls: # Array of url to ignore
- https://github.com
- https://broken/* # wildcard allows
files: # Array of markdown file the shouldn't parse
- ./test.md # Relative path from the folder shared above
delay:
'https://gitlab.com': 500 # Perform a pause of 500ms at each call matching the urlRestQA is an open automation framework based on Gherkin. A few step and your Test automation framework is setup. No dependency the framework is ready to be plug to all your project components Give a try 🚀
- test automation
- Gherkin
- Cucumber
- End to End
- E2E
- Quality assurance
- QA
- Continuous integration
- RestQa