Merge pull request #24 from Xray-App/check_broken_links

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

@@ -96,7 +96,7 @@ That's it.
 
 ##### 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.