chore: update writerside version and display algolia logo in search as required by free plan

Author: twisti-dev

.github/workflows/deploy.yml

@@ -20,7 +20,7 @@ env:
   # Replace HI with the ID of the instance in capital letters
   ARTIFACT: webHelpCCS2-all.zip
   # Writerside docker image version
-  DOCKER_VERSION: 243.21565
+  DOCKER_VERSION: 243.22562
 
   # Add the variable below to upload Algolia indexes
   # Replace HI with the ID of the instance in capital letters
@@ -34,12 +34,35 @@ env:
 jobs:
   build:
     runs-on: ubuntu-latest
+    outputs:
+      algolia_artifact: ${{ steps.define-ids.outputs.algolia_artifact }}
+      artifact: ${{ steps.define-ids.outputs.artifact }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
         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: Build docs using Writerside Docker builder
         uses: JetBrains/writerside-github-action@v4
         with:
@@ -87,9 +110,10 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: docs
+          path: artifacts
 
       - name: Unzip artifact
-        run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d cf-pages
+        run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.artifact }}" -d cf-pages
 
       - name: Publish to Cloudflare Pages
         uses: cloudflare/[email protected]
@@ -113,14 +137,23 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: docs
-      - name: Unzip artifact
+          path: artifacts
+
+      - name: Unzip Algolia artifact
+        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

Writerside/cfg/buildprofiles.xml

@@ -19,6 +19,7 @@
         <algolia-index>docs_cast_crafter_community_server</algolia-index>
         <algolia-api-key>7cf09b7ca00ee35aefbe99fa74174ed6</algolia-api-key>
         <web-root>https://server.castcrafter.de/</web-root>
+        <algolia-show-logo>true</algolia-show-logo>
 
         <enable-contribution>true</enable-contribution>
         <contribute-url>https://github.com/Keviro/community-server-docs/blob/master/Writerside/</contribute-url>
@@ -34,7 +35,7 @@
         <sitemap priority="0.5" change-frequency="daily"/>
     </build-profile>
     <footer>
-        <copyright>CastCrafter Community Server 2021-2024 | Not an official Minecraft Product. Not approved by or associated with Mojang or Microsoft</copyright>
+        <copyright>CastCrafter Community Server 2021–2024 | Not an official Minecraft Product. Not approved by or associated with Mojang or Microsoft</copyright>
         <social type="youtube" href="https://www.youtube.com/@CastCrafter">
             YouTube
         </social>