Update Writerside again

TeenBiscuits · TeenBiscuits · commit 58de4feec152 · 2024-12-12T17:17:08.000+01:00
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -6,29 +6,30 @@ name: 🚀 Despliegue documentación
 
 on:
   push:
-    paths: ["docs/**"]
-    branches: ["main"]
+    paths: [ "docs/**" ]
+    branches: [ "main" ]
   workflow_dispatch:
 
 permissions:
+  contents: read
   id-token: write
   pages: write
 
 env:
   INSTANCE: 'docs/pro'
-  ARTIFACT: 'webHelpPRO2-all.zip'
-  DOCKER_VERSION: '243.21565'
-  ALGOLIA_ARTIFACT: 'algolia-indexes-PRO.zip'
+  DOCKER_VERSION: '243.22562'
   ALGOLIA_APP_NAME: '0K3UBN277V'
   ALGOLIA_INDEX_NAME: 'pro2324'
-  ALGOLIA_KEY: '${{ secrets.ALGOLIA_KEY }}'
   CONFIG_JSON_PRODUCT: 'PRO'
   CONFIG_JSON_VERSION: '1.0'
 
 jobs:
   construir:
     name: 📦 Construir
     runs-on: ubuntu-latest
+    outputs:
+      algolia_artifact: ${{ steps.define-ids.outputs.algolia_artifact }}
+      artifact: ${{ steps.define-ids.outputs.artifact }}
     steps:
       - name: ⬇️ Checkout repositorio
         # GitHub Actions
@@ -38,6 +39,26 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: ✳️ Define instance id and artifacts
+        id: define-ids
+        run: |
+          INSTANCE=${INSTANCE#*/}
+          INSTANCE_ID_UPPER=$(echo "$INSTANCE" | tr '[:lower:]' '[:upper:]')
+          ARTIFACT="webHelp${INSTANCE_ID_UPPER}2-all.zip"
+          ALGOLIA_ARTIFACT="algolia-indexes-${INSTANCE_ID_UPPER}.zip"
+
+          # Print the values
+          echo "INSTANCE_ID_UPPER: $INSTANCE_ID_UPPER"
+          echo "ARTIFACT: $ARTIFACT"
+          echo "ALGOLIA_ARTIFACT: $ALGOLIA_ARTIFACT"
+
+          # Set the environment variables and outputs
+          echo "INSTANCE_ID_UPPER=$INSTANCE_ID_UPPER" >> $GITHUB_ENV
+          echo "ARTIFACT=$ARTIFACT" >> $GITHUB_ENV
+          echo "ALGOLIA_ARTIFACT=$ALGOLIA_ARTIFACT" >> $GITHUB_ENV
+          echo "artifact=$ARTIFACT" >> $GITHUB_OUTPUT
+          echo "algolia_artifact=$ALGOLIA_ARTIFACT" >> $GITHUB_OUTPUT
+
       - name: 🏗️ Construir con Writerside usando Docker
         # JetBrains Open Source
         # Apache-2.0
@@ -89,7 +110,7 @@ jobs:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    needs: [construir, comprobar]
+    needs: [ construir, comprobar ]
     runs-on: ubuntu-latest
     steps:
       - name: ⬇️ Descargar artefacto
@@ -99,9 +120,10 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: docs
+          path: artifacts
 
       - name: 🗃️ Descomprimir artefacto
-        run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir
+        run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.artifact }}" -d dir
 
       - name: 🔎 Configurar IndexNow
         run: echo ${{ secrets.INDEXNOW_KEY }} > dir/${{ secrets.INDEXNOW_KEY }}.txt
@@ -110,9 +132,9 @@ jobs:
         run: |
           curl https://raw.githubusercontent.com/TeenBiscuits/Pro2324/main/docs/cfg/robots.txt -o dir/robots.txt && \
           curl https://raw.githubusercontent.com/TeenBiscuits/Pro2324/main/docs/cfg/humans.txt -o dir/humans.txt
-      
+
       - name: 🔩 Configurar Pages
-        uses: actions/configure-pages@v5
+        uses: actions/configure-pages@v4
 
       - name: 📦 Empaquetar y subir artefacto de Pages
         uses: actions/upload-pages-artifact@v3
@@ -129,7 +151,7 @@ jobs:
   publicar-indexes:
     name: 🔎 Algolia Index
     if: github.repository == 'TeenBiscuits/Pro2324'
-    needs: [construir, comprobar, publicar]
+    needs: [ construir, comprobar, publicar ]
     runs-on: ubuntu-latest
     container:
       image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3
@@ -141,20 +163,27 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: docs
+          path: artifacts
       - name: 🗃️ Descomprimir artefacto
+        run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.algolia_artifact }}" -d algolia-indexes
+      - name: 🆙 Update Algolia Index
         run: |
-          unzip -O UTF-8 -qq '${{ env.ALGOLIA_ARTIFACT }}' -d algolia-indexes
-          env algolia-key='${{env.ALGOLIA_KEY}}' java -jar /opt/builder/help-publication-agent.jar \
-          update-index \
-          --application-name '${{env.ALGOLIA_APP_NAME}}' \
-          --index-name '${{env.ALGOLIA_INDEX_NAME}}' \
-          --product '${{env.CONFIG_JSON_PRODUCT}}' \
-          --version '${{env.CONFIG_JSON_VERSION}}' \
-          --index-directory algolia-indexes/ \
-          2>&1 | tee algolia-update-index-log.txt
+          if [ -z "${{ secrets.ALGOLIA_KEY }}" ]; then
+            echo "ALGOLIA_KEY secret is not set in GitHub Secrets"
+            exit 1
+          else
+            env "algolia-key=${{ secrets.ALGOLIA_KEY }}" java -jar /opt/builder/help-publication-agent.jar \
+            update-index \
+            --application-name ${{ env.ALGOLIA_APP_NAME }} \
+            --index-name ${{ env.ALGOLIA_INDEX_NAME }} \
+            --product ${{ env.CONFIG_JSON_PRODUCT }} \
+            --version ${{ env.CONFIG_JSON_VERSION }} \
+            --index-directory algolia-indexes/ \
+            2>&1 | tee algolia-update-index-log.txt
+          fi
 
   indexnow:
-    needs: [construir, comprobar, publicar]
+    needs: [ construir, comprobar, publicar ]
     name: 🔎 Bing IndexNow
     if: github.repository == 'TeenBiscuits/Pro2324'
     runs-on: ubuntu-latest
@@ -172,7 +201,7 @@ jobs:
           failure-strategy: error
 
   google-indexing:
-    needs: [construir, comprobar, publicar]
+    needs: [ construir, comprobar, publicar ]
     name: 🔎 Google Index
     if: github.repository == 'TeenBiscuits/Pro2324'
     runs-on: ubuntu-latest
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -6,23 +6,26 @@ name: 🔬 Comprobar documentación
 
 on:
   pull_request:
-    types: ["opened"]
-    paths: ["docs/**"]
+    types: [ "opened" ]
+    paths: [ "docs/**" ]
   workflow_dispatch:
 
 permissions:
+  contents: read
   id-token: write
   pages: write
 
 env:
   INSTANCE: 'docs/pro'
-  ARTIFACT: 'webHelpPRO2-all.zip'
-  DOCKER_VERSION: '243.21565'
+  DOCKER_VERSION: '243.22562'
 
 jobs:
   construir:
     name: 📦 Construir
     runs-on: ubuntu-latest
+    outputs:
+      algolia_artifact: ${{ steps.define-ids.outputs.algolia_artifact }}
+      artifact: ${{ steps.define-ids.outputs.artifact }}
     steps:
       - name: ⬇️ Checkout repositorio
         # GitHub Actions
@@ -32,6 +35,26 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: ✳️ Define instance id and artifacts
+        id: define-ids
+        run: |
+          INSTANCE=${INSTANCE#*/}
+          INSTANCE_ID_UPPER=$(echo "$INSTANCE" | tr '[:lower:]' '[:upper:]')
+          ARTIFACT="webHelp${INSTANCE_ID_UPPER}2-all.zip"
+          ALGOLIA_ARTIFACT="algolia-indexes-${INSTANCE_ID_UPPER}.zip"
+
+          # Print the values
+          echo "INSTANCE_ID_UPPER: $INSTANCE_ID_UPPER"
+          echo "ARTIFACT: $ARTIFACT"
+          echo "ALGOLIA_ARTIFACT: $ALGOLIA_ARTIFACT"
+
+          # Set the environment variables and outputs
+          echo "INSTANCE_ID_UPPER=$INSTANCE_ID_UPPER" >> $GITHUB_ENV
+          echo "ARTIFACT=$ARTIFACT" >> $GITHUB_ENV
+          echo "ALGOLIA_ARTIFACT=$ALGOLIA_ARTIFACT" >> $GITHUB_ENV
+          echo "artifact=$ARTIFACT" >> $GITHUB_OUTPUT
+          echo "algolia_artifact=$ALGOLIA_ARTIFACT" >> $GITHUB_OUTPUT
+
       - name: 🏗️ Construir con Writerside usando Docker
         # JetBrains Open Source
         # Apache-2.0
diff --git a/docs/cfg/buildprofiles.xml b/docs/cfg/buildprofiles.xml
@@ -24,6 +24,7 @@ SPDX-License-Identifier: GPL-3.0-only
         <algolia-id>0K3UBN277V</algolia-id>
         <algolia-index>pro2324</algolia-index>
         <algolia-api-key>d4e81705240b4f5de1022e3a86236964</algolia-api-key>
+        <algolia-show-logo>true</algolia-show-logo>
         <!-- ANALYTICS AND COOKIE BANNER -->
         <analytics-head-script-file>analytics.js</analytics-head-script-file>
         <!-- EDIT GITHUB -->
