check broken links on local markdown files

.github/workflows/PR.yml

@@ -18,10 +18,11 @@ jobs:
         java-version: 17
     - name: Build with Maven
       run: mvn -B package --file pom.xml
+    - name: Check broken links in documentation using Markup Link Checker (mlc)
+      uses: becheran/[email protected]
     - name: Generate JaCoCo Badge
       id: jacoco
       uses: cicirello/[email protected]
-
     - name: Log coverage percentage
       run: |
         echo "coverage = ${{ steps.jacoco.outputs.coverage }}"

README.md

@@ -3,11 +3,11 @@
 [![build workflow](https://github.com/Xray-App/xray-testng-extensions/actions/workflows/maven.yml/badge.svg)](https://github.com/Xray-App/xray-testng-extensions/actions/workflows/maven.yml)
 ![code coverage](
 https://raw.githubusercontent.com/Xray-App/xray-testng-extensions/master/.github/badges/jacoco.svg)
 [![license](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
 [![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-testng-extensions)](https://central.sonatype.com/artifact/app.getxray/xray-testng-extensions/)
 
 This repo contains several enhancements to TestNG to allow you to take better advantage of [TestNG](https://testng.org/) whenever using it together with [Xray Test Management](https://getxray.app). This includes specific annotations and listener(s) that can then process their information.
 
 This code is provided as-is; you're free to use it and modify it at your will (see license ahead).
 
@@ -16,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)).
 
 The idea is to be able to produce a 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, usually through new annotations.
@@ -96,7 +96,7 @@
 
 ##### 1. Enable the listener(s)
 
-In order to embed additional information on the customized TestNG XML report, we need to register the **XrayListener** listener. This can be done in [several ways](https://testng.org/doc/documentation-main.html#testng-listeners):
+In order to embed additional information on the customized TestNG XML report, we need to register the **XrayListener** listener. This can be done in [several ways](https://testng.org/#_testng_listeners):
 
 - it can be discovered automatically at runtime by the ServiceLoader based on the contents of a file (e.g `src/test/resources/META-INF/services/org.testng.ITestNGListener`); this is probably the easiest one.
 
@@ -559,19 +559,19 @@
 
 ## 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
 
 - [Example using TestNG with Xray on Jira server/DC (using TestNG XML report)](https://docs.getxray.app/display/XRAY/Testing+using+TestNG+in+Java)
 - [Example using TestNG with Xray on Jira Cloud (using TestNG XML report)](https://docs.getxray.app/display/XRAYCLOUD/Testing+using+TestNG+in+Java)
 - [original discussion on customization of TestNG XML report](https://github.com/cbeust/testng/issues/2171)
 - [enhanced TestNG XML report file format](https://docs.getxray.app/display/XRAYCLOUDDRAFT/Taking+advantage+of+TestNG+XML+reports)
 - [TestNG XML endpoints for submiting results sto Xray Cloud](https://docs.getxray.app/display/XRAYCLOUD/Import+Execution+Results+-+REST#ImportExecutionResultsREST-TestNGXMLresults)
 - [TestNG XML endpoints for submiting results to Xray server/DC](https://docs.getxray.app/display/XRAY/Import+Execution+Results+-+REST#ImportExecutionResultsREST-XrayJSONresults)
 - [Xray JSON format and endpoint for submiting results to Xray cloud](https://docs.getxray.app/display/XRAYCLOUDDRAFT/Import+Execution+Results+-+REST+v2#ImportExecutionResultsRESTv2-XrayJSONresults)
 - [Xray JSON format and endpoint for submiting results to Xray server/DC](https://docs.getxray.app/display/XRAY/Import+Execution+Results+-+REST#ImportExecutionResultsREST-XrayJSONresults)
 - [tutorials showcasing uploading test results from CI/CD tools to Xray cloud](https://docs.getxray.app/display/XRAYCLOUD/Integrations)
 - [tutorials showcasing uploading test results from CI/CD tools to Xray server/DC](https://docs.getxray.app/display/XRAY/Integrations)