feat: content of about page now generated based on information from R…

…EADME.md (#36)
SchweizerischeBundesbahnen · Jun 24, 2024 · 46628ef · 46628ef
1 parent be1e848
commit 46628ef
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 294 deletions.
diff --git a/.github/workflows/maven-release.yml b/.github/workflows/maven-release.yml
@@ -10,14 +10,14 @@ jobs:
       contents: read
       packages: write
     steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4
       - name: Set up JDK and Maven
-        uses: actions/setup-java@99b8673ff64fbf99d8d325f52d9a5bdedb8483e9 # v4
+        uses: actions/setup-java@99b8673ff64fbf99d8d325f52d9a5bdedb8483e9  # v4
         with:
           distribution: adopt
           java-version: 17
           cache: maven
-      - uses: whelk-io/maven-settings-xml-action@9dc09b23833fa9aa7f27b63db287951856f3433d # v22
+      - uses: whelk-io/maven-settings-xml-action@9dc09b23833fa9aa7f27b63db287951856f3433d  # v22
         with:
           repositories: >
             [
@@ -57,7 +57,7 @@ jobs:
       - name: Print settings.xml
         run: cat /home/runner/.m2/settings.xml
       - name: Build with Maven
-        run: mvn --batch-mode -DwpExporterImpl=docker clean package -P polarion2404,tests-with-weasyprint-docker
+        run: mvn --batch-mode -DwpExporterImpl=docker clean package -P tests-with-weasyprint-docker
       - name: Extract artefact version
         id: artefact_version
         run: echo "version=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)" >> $GITHUB_OUTPUT

diff --git a/.gitignore b/.gitignore
@@ -33,3 +33,6 @@ replay_pid*
 target/
 *.iml
 dependency-reduced-pom.xml
+
+src/main/resources/webapp/*-admin/html/about.html
+README.html
diff --git a/.scripts/convert-readme.sh b/.scripts/convert-readme.sh
@@ -0,0 +1,24 @@
+#!/bin/bash
+
+INPUT_FILE="${1:-README.md}"
+OUTPUT_FILE="${2:-README.html}"
+
+# Convert the markdown file to a JSON payload
+jq -R -s '{"mode": "gfm", "text": .}' < "$INPUT_FILE" > payload.json
+
+# Send the JSON payload to the GitHub API
+curl -L \
+  -X POST \
+  -H "Accept: application/vnd.github+json" \
+  -H "X-GitHub-Api-Version: 2022-11-28" \
+  https://api.github.com/markdown \
+  -d @payload.json > "$OUTPUT_FILE"
+
+# Remove the temporary JSON payload
+rm payload.json
+
+# Remove the Build and Installation sections from readme
+awk '
+/<h2>Build<\/h2>/ {skip=1; next}
+/<h2>Polarion configuration<\/h2>/ {skip=0}
+!skip' "$OUTPUT_FILE" > "$OUTPUT_FILE.tmp" && mv "$OUTPUT_FILE.tmp" "$OUTPUT_FILE"
diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>ch.sbb.polarion.extensions</groupId>
         <artifactId>ch.sbb.polarion.extension.generic.parent-pom</artifactId>
-        <version>4.10.0</version>
+        <version>4.11.0</version>
     </parent>
 
     <artifactId>ch.sbb.polarion.extension.pdf-exporter</artifactId>

diff --git a/src/main/resources/webapp/pdf-exporter-admin/html/.gitkeep b/src/main/resources/webapp/pdf-exporter-admin/html/.gitkeep
diff --git a/src/main/resources/webapp/pdf-exporter-admin/html/help/configuration.css b/src/main/resources/webapp/pdf-exporter-admin/html/help/configuration.css
diff --git a/src/main/resources/webapp/pdf-exporter-admin/html/help/configuration.html b/src/main/resources/webapp/pdf-exporter-admin/html/help/configuration.html
diff --git a/src/main/resources/webapp/pdf-exporter-admin/pages/about.jsp b/src/main/resources/webapp/pdf-exporter-admin/pages/about.jsp
@@ -28,7 +28,7 @@
     <title></title>
     <link rel="stylesheet" href="../ui/generic/css/common.css?bundle=<%= version.getBundleBuildTimestampDigitsOnly() %>">
     <link rel="stylesheet" href="../ui/generic/css/about.css?bundle=<%= version.getBundleBuildTimestampDigitsOnly() %>">
-    <link rel="stylesheet" href="../ui/html/help/configuration.css?bundle=<%= version.getBundleBuildTimestampDigitsOnly() %>">
+    <link rel="stylesheet" href="../ui/generic/css/github-markdown-light.css?bundle=<%= version.getBundleBuildTimestampDigitsOnly() %>">
 </head>
 
 <body>
@@ -126,13 +126,15 @@
 
         <input id="scope" type="hidden" value="<%= request.getParameter("scope")%>"/>
 
+        <article class="markdown-body">
         <%
-            try (InputStream inputStream = ExtensionInfo.class.getResourceAsStream("/webapp/pdf-exporter-admin/html/help/configuration.html")) {
+            try (InputStream inputStream = ExtensionInfo.class.getResourceAsStream("/webapp/pdf-exporter-admin/html/about.html")) {
                 assert inputStream != null;
                 String configurationHelp = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
                 out.println(configurationHelp);
             }
         %>
+        </article>
     </div>
 </div>
 </body>