Add algolia search

Author: SerafimArts

.github/workflows/deploy.yml

@@ -17,7 +17,13 @@ env:
   # Replace HI with the ID of the instance in capital letters
   ARTIFACT: webHelpTL2-all.zip
   # Writerside docker image version
-  DOCKER_VERSION: 241.18775
+  DOCKER_VERSION: 242.21870
+  ALGOLIA_ARTIFACT: 'algolia-indexes-HI.zip'
+  ALGOLIA_APP_NAME: 'CZXH99BXN1'
+  ALGOLIA_INDEX_NAME: 'Writerside'
+  ALGOLIA_KEY: '${{ secrets.ALGOLIA_KEY }}'
+  CONFIG_JSON_PRODUCT: 'HI'
+  CONFIG_JSON_VERSION: '1.0'
 
 jobs:
   build:
@@ -28,37 +34,31 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-
       - name: Build Docs
         uses: JetBrains/writerside-github-action@v4
         with:
           instance: ${{ env.INSTANCE }}
           artifact: ${{ env.ARTIFACT }}
           docker-version: ${{ env.DOCKER_VERSION }}
-
       - name: Upload Documentation
         uses: actions/upload-artifact@v4
         with:
           name: docs
           path: |
             artifacts/${{ env.ARTIFACT }}
             artifacts/report.json
+            artifacts/${{ env.ALGOLIA_ARTIFACT }}
           retention-days: 7
 
-  # Add the job below and artifacts/report.json on Upload documentation step
-  # above if you want to fail the build when documentation contains errors.
   test:
-    # Requires build job results
     needs: build
     runs-on: ubuntu-latest
-
     steps:
       - name: Download Artifacts
         uses: actions/download-artifact@v4
         with:
           name: docs
           path: artifacts
-
       - name: Test Documentation
         uses: JetBrains/writerside-checker-action@v1
         with:
@@ -68,26 +68,43 @@ jobs:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    # Requires the build job results
     needs: test
     runs-on: ubuntu-latest
     steps:
       - name: Download Artifact
         uses: actions/download-artifact@v4
         with:
           name: docs
-
       - name: Unzip Artifact
         run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
-
       - name: Setup Pages
         uses: actions/configure-pages@v4
-
       - name: Upload Artifact
         uses: actions/upload-pages-artifact@v3
         with:
           path: dir
-
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
+
+  publish-indexes:
+    needs: [build, test, deploy]
+    runs-on: ubuntu-latest
+    container:
+      image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+      - name: Unzip artifact
+        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

Writerside/cfg/buildprofiles.xml

@@ -25,6 +25,10 @@
         <enable-contribution>true</enable-contribution>
         <contribute-url>https://github.com/php-type-language/docs/blob/master/Writerside/</contribute-url>
         <custom-css>custom.css</custom-css>
+
+        <algolia-id>CZXH99BXN1</algolia-id>
+        <algolia-index>Writerside</algolia-index>
+        <algolia-api-key>70b2d5249859c00508d22cb54c52eeee</algolia-api-key>
     </variables>
 
     <icons>