chore: PDF build - Add design to Vuln ID, fix blank page and wrong bookmark issue (#996)

* Add design to Vuln ID, fix blank page and wrong bookmark issue
* Fix build dependency issue
* Update node version in pdf build action
* Update node version in pdf build action, Patching set-output commands
* Update archived actions to the latest
* Update cover page base image

Author: rejahrehim

.github/pdf/assets/cover.jpg

@@ -14,7 +14,8 @@
     "headerTemplate": "<style>section { margin: 0 15mm; padding:25px 0px 5px 0px; width:100%; font-family: 'system-ui'; font-size: 8px; font-weight: 300; font-style: bold; color:#004391; border-bottom: 1px solid #7DC6E9;}</style><section> <span class=\"pageNumber\" style=\"background-color:#D4F2FD; font-size: 7px; border: 1px solid #D4F2FD; border-radius:50px; padding:5px; color:#0080BD; position:absolute; margin-left:-12.5mm; margin-top:-8mm;\"></span> Web Security Testing Guide {PDF Version}</section>",
     "footerTemplate":"<section style=\"display:none;\"></section>",
     "printBackground":true,
-    "preferCSSPageSize":true
+    "preferCSSPageSize":true,
+    "timeout": "60000"
   },
   "stylesheet_encoding": "utf-8"
 }

.github/pdf/assets/pdf-style.css

@@ -86,9 +86,7 @@ remove_blank_pages () {
 
 # Add page break after each chapter
 add_page_break () {
-sed -e 's/^# /<div style=\"page-break-after: always\;\"><\/div>\
-\
-# /' $1
+    echo '<div style="page-break-after: always;"></div>'
 }
 
 # Replace internal markdown Links inside headings with html anchor tags (<a>)
@@ -204,9 +202,23 @@ add_design_to_image_name_tag () {
    sed 's/\*\(Figure [0-9.ABCDEF\-]*\: .*\)\*/<div class="image-name-tag-wrap"><span class="image-name-tag">\1<\/span><\/div>/'  $1
 }
 
+# Add design to the test case id table
+add_design_to_test_case_id_table () {
+    # sed -e '/<table>/,/<th>ID<\/th>/ s/<table>/<table class="test-case-id-table">/' $1
+    # sed 's/\|ID[.]*\|[\n]\|[-]*\|[\n]\|(WSTG-[A-Z]*-[0-9]*)\|/<table class="test-case-id-table"><thead><tr><th>ID</th></tr></thead><tbody><tr><td>\1</td></tr></tbody></table>/' $1
+    # sed 's/<table>\s<thead>\s<tr>\s<th>ID<\/th>\s<\/tr>\s<\/thead>/<table class="test-case-id-table"><thead><tr><th>ID<\/th><\/tr>\/thead>/' $1
+    sed '
+    /|ID.*|/,/|WSTG-[A-Z]*-[0-9]*|/ {
+        s/|ID.*|//
+        s/|[-]*|//
+        s/|\(WSTG-[A-Z]*-[0-9]*\)|/<ul class="arrowbox"><li class="first">ID<\/li><li class="second">\1<\/li><\/ul>/
+    }
+    ' $1
+}
+
 # Preprocess markdown files to support internal links and image designs
 preprocess_markdown_to_support_md_to_pdf () {
-    cat build/md/$1 | add_page_break | \
+    cat build/md/$1 | \
     replace_internal_markdown_links_with_in_headers_with_html_tags | \
     replace_markdown_headers_with_html_tags | \
     replace_internal_markdown_links_with_html_tags | \
@@ -226,7 +238,8 @@ preprocess_markdown_to_support_md_to_pdf () {
     convert_href_to_lower_case | \
     remove_chapter_numbers_from_link | \
     add_design_to_images | \
-    add_design_to_image_name_tag
+    add_design_to_test_case_id_table | \
+    { add_design_to_image_name_tag; add_page_break;}
 }
 
 extract_chapter_details_and_page_number_from_pdf () {
@@ -336,7 +349,8 @@ while read line; do
     pagenumber=$(($pagenumber+$numberofpages));
     numberofpages=0;
     headerlevel=0;
-
+    sectionTitle1=""
+    sectionTitle2=""
 done < build/chapters.txt;
 
 }
@@ -360,6 +374,9 @@ ls build/md | sort -n | while read x; do preprocess_markdown_to_support_md_to_pd
 # Create document body pages by converting Markdown to PDF
 md-to-pdf  --config-file .github/pdf/pdf-config.json build/wstg-doc-$VERSION.md
 
+# Remove Blank pages from the combined PDF
+remove_blank_pages build/wstg-doc-$VERSION.pdf
+
 # Combine Cover page and Document body
 pdftk build/cover-$VERSION.pdf build/second-cover-$VERSION.pdf build/wstg-doc-$VERSION.pdf build/back-$VERSION.pdf cat output build/wstg-com-$VERSION.pdf
 

.github/pdf/pdf-config.json

@@ -19,13 +19,13 @@ jobs:
       CI: true
     steps:
     - name: Setup Action
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Setup Node
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
-        node-version: 12.x
+        node-version: 16.x
     - name: SetUp python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: '3.x'
     - name: Install dependencies
@@ -37,7 +37,7 @@ jobs:
     - name: Get Tag Version
       if: github.event_name == 'push'
       id: vars
-      run: echo ::set-output name=tag::$(echo ${GITHUB_REF:10})
+      run: echo "tag=$(echo ${GITHUB_REF:10})" >> $GITHUB_OUTPUT
     - name: Run Push Build
       if: github.event_name == 'push'
       run: npm run-script  pdfgen -- ${{ steps.vars.outputs.tag }}
@@ -47,28 +47,20 @@ jobs:
     - name: Create Release
       if: github.event_name == 'push'
       id: create_release
-      uses: actions/create-release@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      uses: ncipollo/[email protected]
       with:
-        tag_name: ${{ github.ref }}
-        release_name: Release ${{ github.ref }}
+        name: Release ${{ steps.vars.outputs.tag }}
+        artifacts: "./build/wstg-${{ steps.vars.outputs.tag }}.pdf"
+        artifactContentType: application/pdf
+        artifactErrorsFailBuild: true
         draft: false
         prerelease: true
-    - name: Upload Release Asset
-      if: github.event_name == 'push'
-      id: upload-release-asset
-      uses: actions/[email protected]
+        token: ${{ secrets.GITHUB_TOKEN }}
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        upload_url: ${{ steps.create_release.outputs.upload_url }}
-        asset_path: ./build/wstg-${{ steps.vars.outputs.tag }}.pdf
-        asset_name: wstg-${{ steps.vars.outputs.tag }}.pdf
-        asset_content_type: application/pdf
     - name: Attach PDF
       if: github.event_name == 'workflow_dispatch'
-      uses: actions/upload-artifact@v1
+      uses: actions/upload-artifact@v3
       with:
         name: wstg-${{ github.event.inputs.version }}.pdf
-        path: ./build/wstg-${{ github.event.inputs.version }}.pdf
+        path: ./build/wstg-${{ github.event.inputs.version }}.pdf

.github/pdf/scripts/make-pdf.sh

@@ -3,7 +3,9 @@
   "version": "1.0.1",
   "description": "[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/OWASP/wstg/issues) [![OWASP Flagship](https://img.shields.io/badge/owasp-flagship-brightgreen.svg)](https://www.owasp.org/index.php/OWASP_Project_Inventory#tab=Flagship_Projects)",
   "main": "index.js",
-  "dependencies": {},
+  "dependencies": {
+    "puppeteer": "^19.2.2"
+  },
   "devDependencies": {
     "markdownlint-cli": "^0.31.1"
   },