From dbf8bc34cb053584f7d8e0a7a7d59b3aab6424cc Mon Sep 17 00:00:00 2001 From: Charan-Sharan Date: Tue, 9 Jul 2024 17:17:17 +0530 Subject: [PATCH] Test hyperlinks testing implementation Signed-off-by: Charan-Sharan --- .github/workflows/Check-hyperlinks.md | 29 +++++++++++++++ .github/workflows/build-vcpkg.yml | 4 +++ .github/workflows/test-hyperlinks.yml | 23 ++++++++---- docs/README.rst | 7 ---- ecl/ecl-bundle/README.rst | 3 +- ecl/hql/README.rst | 7 ---- ecl/sourcedoc.xml | 40 --------------------- system/masking/plugins/datamasker/readme.md | 1 + 8 files changed, 53 insertions(+), 61 deletions(-) create mode 100644 .github/workflows/Check-hyperlinks.md delete mode 100644 docs/README.rst delete mode 100644 ecl/hql/README.rst delete mode 100644 ecl/sourcedoc.xml diff --git a/.github/workflows/Check-hyperlinks.md b/.github/workflows/Check-hyperlinks.md new file mode 100644 index 00000000000..694f01a40aa --- /dev/null +++ b/.github/workflows/Check-hyperlinks.md @@ -0,0 +1,29 @@ +[HPCC Wiki](https://hpccsystems.atlassian.net/wiki/spaces/hpcc/overview) +[HPCC Wiki](https://hpccsystems.atlassian.net/wiki/spaces/hpcc/overview) +[Sub Heading 1](#sub-heading-1) +[Sub Heading 2](#sub-heading-2) + +## Sub Heading 1 +Lorem ipsum dolor sit amet consectetur adipisicing elit. Hic maiores vero deleniti, quas dolorum vel. +Facere voluptas vero ab, quasi repellat quam consequatur totam iste, perspiciatis, dolorem sunt nostrum placeat! +Provident maxime quam cupiditate blanditiis repellat, quas id fugiat illo deserunt laboriosam dolorum. Hic, voluptatum. +Beatae perspiciatis cum repudiandae reprehenderit debitis alias et. Tempora sed, ab fuga nesciunt quaerat voluptatibus! +Nisi rem asperiores voluptas assumenda, veritatis iure porro necessitatibus est. Atque possimus incidunt est accusantium. +Ratione a odio blanditiis similique eveniet eligendi illum consectetur eius. Impedit fugiat quae eius libero. +Quidem ut ea suscipit nesciunt, eligendi quam saepe dolore id repellendus iure eius, dicta voluptatum! +Odit reiciendis esse hic tempore? Minus quod enim, deserunt sapiente illo commodi assumenda nobis! Blanditiis. +Eius officia odit nisi, distinctio eos quo voluptatem, earum illum quibusdam voluptates dolorem. Perspiciatis, quis? +Aperiam quam vero aut odit, sunt quasi modi minima. Ex nostrum debitis quod voluptatum assumenda? +## Sub Heading 2 + +Lorem, ipsum dolor sit amet consectetur adipisicing elit. Est aspernatur quas sint modi voluptas voluptates. +Dolorum eum dignissimos architecto. Ullam, accusamus saepe deleniti distinctio dicta nostrum. Ex labore fugiat ipsam? +Quia dicta assumenda ratione autem pariatur magnam, placeat neque quos. Sequi necessitatibus ex odio accusantium? +Sed quibusdam consectetur, dolore, molestias magni illum delectus adipisci, iure ad rem sapiente officia vel! +Suscipit numquam perspiciatis laboriosam? Nobis nulla https://github.com/HPCC-Systems/HPCC-Platform/ minus ad, provident optio labore. Cumque tempora deserunt delectus. +Necessitatibus optio totam rerum, molestias veritatis, quia mollitia deserunt sed possimus, nulla aliquam tempora in! +Qui consectetur, officiis nostrum atque eaque repudiandae dolorum minima ab ullam. Placeat aliquid commodi corrupti. +Consequuntur, ad provident. Rem, iste mollitia https://github.com/HPCC-Systems/HPCC-Platform/ inventore corporis omnis voluptates et non repellat debitis dolorum. +Voluptatum deserunt nihil ullam sint veniam cumque, dignissimos explicabo maxime quod libero ex labore sequi. +Explicabo atque maxime amet repellat voluptate velit, officia consequuntur odit ea iusto placeat beatae voluptatibus! + diff --git a/.github/workflows/build-vcpkg.yml b/.github/workflows/build-vcpkg.yml index 29a86b2463b..85597e04ddc 100644 --- a/.github/workflows/build-vcpkg.yml +++ b/.github/workflows/build-vcpkg.yml @@ -41,6 +41,10 @@ on: - "!candidate-7.2.*" - "!candidate-7.0.*" - "!candidate-6.*" + paths: + - "!*.md" + - "!*.rst" + - "!*.xml" schedule: - cron: "0 0 * * *" diff --git a/.github/workflows/test-hyperlinks.yml b/.github/workflows/test-hyperlinks.yml index 1bb302e6e5f..fe22998d55d 100644 --- a/.github/workflows/test-hyperlinks.yml +++ b/.github/workflows/test-hyperlinks.yml @@ -45,6 +45,7 @@ jobs: - name: List links from Documentation files run: | IFS=$'\n' + touch missingFiles.txt for FILE in $( cat xmlFilesList.txt ) do #check if the file is missing @@ -78,7 +79,7 @@ jobs: echo $FILE >> missingFiles.txt continue fi - grep -onHE -e "\]\([^\)]+" -e "\`\`\`[^\`]*" -e "http://[^\ \;\"\'\<\>\]\[\,\`\)]+" -e "https://[^\ \;\"\'\<\>\]\[\,\`\)]+" ${FILE} | sed 's/](//' > links.tmp + grep -onHE -e "\]\([^\)]+" -e "\`\`\`[^\`]*" -e "http://[^\ \;\"\'\<\>\,\`\)]+" -e "https://[^\ \;\"\'\<\>\,\`\)]+" ${FILE} | sed 's/](//' > links.tmp FLAG=0 for LINE in $( cat links.tmp ) do @@ -215,16 +216,26 @@ jobs: echo -e "Broken links: \n" > error-report.log cat error-reportTmp.log >> error-report.log else - echo -e "Missing Files: \n" > error-report.log - cat missingFiles.txt >> error-report.log - echo -e "Broken links: \n" >> error-report.log + echo -e "Missing Files:" > error-report.log + FILE_COUNT=1 + for FILE in $( cat missingFiles.txt ) + do + echo -e "\t${FILE_COUNT}. ${FILE}" >> error-report.log + FILE_COUNT=$(( FILE_COUNT + 1 )) + done + echo -e "\nBroken links: \n" >> error-report.log cat error-reportTmp.log >> error-report.log fi - if [[ ${{ github.event_name }} == "pull_request" || ${{ inputs.Debug-Mode }} == false ]]; then + if [ -z ${{ inputs.Debug-Mode }} ]; then + DEBUG_MODE=false + else + DEBUG_MODE=${{ inputs.Debug-Mode }} + fi + if [[ ${{ github.event_name }} == "pull_request" || $DEBUG_MODE == false ]]; then rm -rf *FilesList.txt \ checkedLinksCache.txt \ *Links.txt \ - linksList.txt \ + linksList.txt fi - name: Upload logs diff --git a/docs/README.rst b/docs/README.rst deleted file mode 100644 index 0a953abc31c..00000000000 --- a/docs/README.rst +++ /dev/null @@ -1,7 +0,0 @@ -This directory contains DocBook source for the HPCC Documentation, and CMake files for building -rendered versions of the documentation from thoses sources. - -Details of the structure of the documentation sources and the CMake process to build them are -found in the `Documentation Source Documentation`_. - -.. _Documentation Source Documentation: DOCUMENTATION.rst diff --git a/ecl/ecl-bundle/README.rst b/ecl/ecl-bundle/README.rst index 76725a9dca9..db9b9a42677 100644 --- a/ecl/ecl-bundle/README.rst +++ b/ecl/ecl-bundle/README.rst @@ -8,7 +8,8 @@ Information about the internals of ecl-bundle is found in the `ecl-bundle Source Information about how to write an ecl bundle is found in the `ECL Bundle Writer's Guide`_. Information about how to use ecl-bundle can be found using the command "ecl bundle help", + or in the printed documentation. -.. _ecl-bundle Source Documentation: DOCUMENTATION.rst +.. _ecl-bundle Source Documentation: DOCUMENTATION.md .. _ECL Bundle Writer's Guide: BUNDLES.rst \ No newline at end of file diff --git a/ecl/hql/README.rst b/ecl/hql/README.rst deleted file mode 100644 index 3e5ed7ad2d2..00000000000 --- a/ecl/hql/README.rst +++ /dev/null @@ -1,7 +0,0 @@ -This directory contains the classes and interfaces for parsing and representing an ecl expression graph. - -The ECL language is documented in the ecl language reference manual (generated as ECLLanguageReference-.pdf). - -Details of the internals of eclcc are found in the `Code Generator Documentation`_. - -.. _Code Generator Documentation: ../eclcc/DOCUMENTATION.rst diff --git a/ecl/sourcedoc.xml b/ecl/sourcedoc.xml deleted file mode 100644 index 9096d9af95c..00000000000 --- a/ecl/sourcedoc.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - -
- ecl - - - The ecl directory contains the sources for the ECL language compiler and related - tools and libraries. - - - - - - - - - - - - - - -
diff --git a/system/masking/plugins/datamasker/readme.md b/system/masking/plugins/datamasker/readme.md index a91b46d5ca9..f9ee1f48dd5 100644 --- a/system/masking/plugins/datamasker/readme.md +++ b/system/masking/plugins/datamasker/readme.md @@ -180,3 +180,4 @@ Returns a (possibly empty) collection of profiles supporting `maskValue` and `ma - Value type mask styles are implemented using [CPartialMaskStyle](#cpartialmaskstyle). - Value type and profile rules are implemented using [CSerialTokenRule](#cserialtokenrule). - Profile contexts are implemented using [CContext](#ccontext). +