check broken links on local docs

.github/workflows/PR.yml

@@ -16,6 +16,9 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
+    - name: Check broken links in documentation using Markup Link Checker (mlc)
+      uses: becheran/[email protected]
+      if: runner.os == 'Linux'
     - name: Set up JDK 1.8
       uses: actions/setup-java@v1
       with:

README.md

@@ -4,12 +4,11 @@
 [![Known Vulnerabilities](https://snyk.io/test/github/Xray-App/xray-junit-extensions/badge.svg)](https://snyk.io/test/github/Xray-App/xray-junit-extensions)
 ![code coverage](
 https://raw.githubusercontent.com/Xray-App/xray-junit-extensions/main/.github/badges/jacoco.svg)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/686a52b4d223469d894af90071ee93d2)](https://www.codacy.com/gh/Xray-App/xray-junit-extensions/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Xray-App/xray-junit-extensions&utm_campaign=Badge_Grade)
 [![license](https://img.shields.io/badge/License-EPL%202.0-green.svg)](https://opensource.org/licenses/EPL-2.0)
 [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/Xray-App/community)
 [![Maven Central Version](https://img.shields.io/maven-central/v/app.getxray/xray-junit-extensions)](https://central.sonatype.com/artifact/app.getxray/xray-junit-extensions/)
 
 This repo contains several improvements for [JUnit](https://junit.org/junit5/) that allow you to take better advantage of JUnit 5 (jupiter engine) whenever using it together with [Xray Test Management](https://getxray.app).
 This code is provided as-is; you're free to use it and modify it at your will (see license ahead).
 
 This is a preliminary release so it is subject to changes, at any time.
@@ -17,7 +16,7 @@
 ## Overview
 
 Results from automated scripts implemented as `@Test` methods can be tracked in test management tools to provide insights about quality aspects targeted by those scripts and their impacts.
 Therefore, it's important to attach some relevant information during the execution of the tests, so it can be shared and analyzed later on in the test management tool (e.g. [Xray Test Management](https://getxray.app)).
 
 This project is highly based on previous work by the JUnit team. The idea is to be able to produce a custom JUnit XML report containing additional information that Xray can take advantage of.
 This way, testers can automate the test script and at the same time provide information such as the covered requirement, right from the test automation code. Additional information may be provided, either through new annotations or by injecting a custom reporter as argument to the test method, using a specific extension.
@@ -239,9 +238,9 @@
 
 ## Contact
 
 You may find me on [Twitter](https://twitter.com/darktelecom).
 Any questions related with this code, please raise issues in this GitHub project. Feel free to contribute and submit PR's.
 For Xray specific questions, please contact [Xray's support team](https://jira.getxray.app/servicedesk/customer/portal/2).
 
 ## References