Cleanup repo and improve docs

.github/workflows/codeql-analysis.yml

@@ -38,11 +38,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -53,7 +53,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -67,4 +67,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/config/url-checker-config.json

@@ -0,0 +1,21 @@
+{
+    "ignorePatterns": [
+        {
+            "pattern": "changelog"
+        }
+    ],
+    "httpHeaders": [
+        {
+            "urls": [
+                "https://",
+                "http://"
+            ],
+            "headers": {
+                "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:64.0) Gecko/20100101 Firefox/64.0"
+            }
+        }
+    ],
+    "retryOn429": true,
+    "fallbackRetryDelay": "30s",
+    "see": "https://github.com/tcort/markdown-link-check#config-file-format"
+}

.github/workflows/docgenerator.yml

@@ -1,170 +1,57 @@
-name: Documents Build
+name: MASVS Build
 
 on: [push, workflow_dispatch]
 
 jobs:
+  Generate-MASVS-Documents:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 1
 
-##
-## Use `pandocker-tag: TAG=stable-full` for langs that require the special fonts (Russian, Chinese, etc.)
-##
-
-  en:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document
-      language: English
-      lang: en
-
-  de:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document-de
-      language: German
-      lang: de
-
-  es:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document-es
-      language: Spanish
-      lang: es
-
-  fr:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document-fr
-      language: French
-      lang: fr
-
-  ptbr:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document-ptbr
-      language: Brazilian Portuguese
-      lang: ptbr
-
-  ptpt:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document-ptpt
-      language: Portugal Portuguese
-      lang: ptpt
-
-  hi:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document-hi
-      language: Hindi
-      lang: hi
-      pandocker-tag: TAG=stable-full
-
-  ja:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document-ja
-      language: Japanese
-      lang: ja
-      pandocker-tag: TAG=stable-full
-
-  ko:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document-ko
-      language: Korean
-      lang: ko
-      pandocker-tag: TAG=stable-full
+    - name: Set MASVS_VERSION to env 
+      run: echo "MASVS_VERSION=$(curl -s https://api.github.com/repos/OWASP/masvs/tags | jq '.[0].name' | sed 's/\"//g')" >> $GITHUB_ENV
 
-  ru:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document-ru
-      language: Russian
-      lang: ru
-      pandocker-tag: TAG=stable-full
+    - name: Set DEV MASVS_VERSION if it's not a tag
+      if: ${{ !startsWith(github.ref, 'refs/tags/') }}
+      run: echo "MASVS_VERSION=${{env.MASVS_VERSION}}-$(git rev-parse --short HEAD)" >> $GITHUB_ENV
 
-  fa:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document-fa
-      language: Persian
-      lang: fa
-      pandocker-tag: TAG=stable-full
-      pandocker-template: LATEX_TEMPLATE=default # there's a bug for fa in the eisvogel template, we have to use default
+    - name: Get Latest MASTG Release Tag
+      run: echo "MASTG_VERSION=$(curl -s https://api.github.com/repos/OWASP/mastg/releases/latest | jq '.tag_name' | sed 's/\"//g')" >> $GITHUB_ENV
 
-  zhcn:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document-zhcn
-      language: Simplified Chinese
-      lang: zhcn
-      pandocker-tag: TAG=stable-full
 
-  zhtw:
-    uses: OWASP/owasp-masvs/.github/workflows/doc-gen-reusable.yml@master
-    with:
-      folder: Document-zhtw
-      language: Traditional Chinese
-      lang: zhtw
-      pandocker-tag: TAG=stable-full
 
-  export:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 1
+    - name: Generate MASVS yaml
+      run: python3 ./tools/generate_masvs_yaml.py -v ${{ env.MASVS_VERSION }}
 
-    # tag name with the latest tag 
-    # and the abbreviated hash of the most recent commit
-    - name: Set VERSION to env 
-      run: echo "VERSION=$(curl -s https://api.github.com/repos/OWASP/owasp-masvs/tags | jq '.[0].name' | sed 's/\"//g')" >> $GITHUB_ENV
+    - name: Populate MASVS Categories Markdown Files
+      run: python3 ./tools/populate_masvs_categories_md.py
 
-    - name: Set DEV VERSION if it's not a tag
-      if: ${{ !startsWith(github.ref, 'refs/tags/') }}
-      run: echo "VERSION=${{env.VERSION}}-$(git rev-parse --short HEAD)" >> $GITHUB_ENV
+    - name: Generate PDF and ePub
+      run: ./tools/docker/pandoc_makedocs.sh Document ${{ env.MASVS_VERSION }} ${{ env.MASTG_VERSION }}
 
-    - name: Install pyyaml
-      run: pip3 install pyyaml
+    - name: Generate CycloneDX JSON
+      run: python3 ./tools/generate_masvs_cyclonedx.py
 
-    - name: Generate CSV
-      run: cd tools && python3 export.py --format csv --lang en > OWASP_MASVS-${{env.VERSION}}.csv
-    - name: Generate JSON
-      run: cd tools && python3 export.py --format json --lang en > OWASP_MASVS-${{env.VERSION}}.json
-    - name: Generate XML
-      run: cd tools && python3 export.py --format xml --lang en > OWASP_MASVS-${{env.VERSION}}.xml
-    - name: Generate MASVS YAML
-      run: cd tools && python3 export.py --format yaml --lang en > OWASP_MASVS-${{env.VERSION}}.yaml
+    - name: Generate SARIF
+      run: python3 ./tools/generate_masvs_sarif.py
 
-    - name: Upload CSV
-      uses: actions/upload-artifact@v2
-      with:
-        name: OWASP_MASVS-${{env.VERSION}}.csv
-        path: tools/OWASP_MASVS-${{env.VERSION}}.csv
-    - name: Upload JSON
-      uses: actions/upload-artifact@v2
-      with:
-        name: OWASP_MASVS-${{env.VERSION}}.json
-        path: tools/OWASP_MASVS-${{env.VERSION}}.json
-    - name: Upload XML
-      uses: actions/upload-artifact@v2
-      with:
-        name: OWASP_MASVS-${{env.VERSION}}.xml
-        path: tools/OWASP_MASVS-${{env.VERSION}}.xml
-    - name: Upload YAML
-      uses: actions/upload-artifact@v2
+    - name: Upload Artifacts
+      uses: actions/upload-artifact@v4
       with:
-        name: OWASP_MASVS-${{env.VERSION}}.yaml
-        path: tools/OWASP_MASVS-${{env.VERSION}}.yaml
+        name: OWASP_MASVS
+        path: OWASP_MASVS*
 
   release:
     runs-on: ubuntu-latest
-    needs: [en, de, fa, es, fr, hi, ja, ko, ptbr, ptpt, ru, zhcn, zhtw, export]
+    needs: [Generate-MASVS-Documents]
     if: startsWith(github.ref, 'refs/tags/') && (github.actor == 'cpholguera' || github.actor == 'sushi2k')
     steps:
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
+      - name: Move all files to the root folder
+        run: mv OWASP_MASVS*/* .
 
-      - name: Move all translations (pdf, epub and docx) to root
-        run: mv OWASP_MASVS-*-*/* .
       - name: Release
         uses: softprops/action-gh-release@v1
         with:
@@ -173,11 +60,10 @@ jobs:
           generate_release_notes: true
           discussion_category_name: Announcements
           files: |
-            OWASP_MASVS-*.pdf
-            OWASP_MASVS-*.epub
-            OWASP_MASVS-*.docx
-            OWASP_MASVS-*.csv/OWASP_MASVS-*.csv
-            OWASP_MASVS-*.json/OWASP_MASVS-*.json
-            OWASP_MASVS-*.xml/OWASP_MASVS-*.xml
+            OWASP_MASVS.pdf
+            OWASP_MASVS.epub
+            OWASP_MASVS.yaml
+            OWASP_MASVS.cdx.json
+            OWASP_MASVS.sarif
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/checkLint.yml → .github/workflows/markdown-linter.yml

@@ -7,12 +7,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 1
       - name: markdownlint-cli
         uses: nosborn/github-action-markdown-cli@v2.0.0
         with:
           files: './Document*'
-          config_file: ".github/workflows/config/.markdownlint.json"
+          config_file: ".markdownlint.jsonc"
           ignore_files: "tools, node_modules"

.github/workflows/codespell.yml → .github/workflows/spell-checker.yml

@@ -1,11 +1,11 @@
-name: codespell
+name: Spell Checker
 on: [pull_request, push]
 jobs:
-  codespell:
+  spell-check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: codespell-project/actions-codespell@master
         with:
           path: ./Document
-          ignore_words_list: ba,compliancy,firt,ist,keypair,ligh,ser,synopsys,zuser
+          ignore_words_list: OWASP,MASVS,MASTG