This repository has been archived by the owner on Dec 31, 2024. It is now read-only.
Update Writerside again #226
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # SPDX-FileCopyrightText: 2024 Pablo Portas López <[email protected]> | |
| # | |
| # SPDX-License-Identifier: GPL-3.0-only AND MIT AND Apache-2.0 | |
| name: 🚀 Despliegue documentación | |
| on: | |
| push: | |
| paths: [ "docs/**" ] | |
| branches: [ "main" ] | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| id-token: write | |
| pages: write | |
| env: | |
| INSTANCE: 'docs/pro' | |
| DOCKER_VERSION: '243.22562' | |
| ALGOLIA_APP_NAME: '0K3UBN277V' | |
| ALGOLIA_INDEX_NAME: 'pro2324' | |
| 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 | |
| # MIT | |
| # https://github.com/actions/checkout | |
| 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: 🏗️ Construir con Writerside usando Docker | |
| # JetBrains Open Source | |
| # Apache-2.0 | |
| # https://github.com/JetBrains/writerside-github-action | |
| uses: JetBrains/writerside-github-action@v4 | |
| with: | |
| instance: ${{ env.INSTANCE }} | |
| artifact: ${{ env.ARTIFACT }} | |
| docker-version: ${{ env.DOCKER_VERSION }} | |
| - name: ⬆️ Subir artefacto con los resultados de la construcción | |
| uses: actions/upload-artifact@v4 | |
| # GitHub Actions | |
| # MIT | |
| # https://github.com/actions/upload-artifact | |
| with: | |
| name: docs | |
| path: | | |
| artifacts/${{ env.ARTIFACT }} | |
| artifacts/report.json | |
| artifacts/${{ env.ALGOLIA_ARTIFACT }} | |
| retention-days: 7 | |
| comprobar: | |
| name: 📊 Comprobar | |
| needs: construir | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: ⬇️ Descargar artefactos | |
| # GitHub Actions | |
| # MIT | |
| # https://github.com/actions/download-artifact | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: docs | |
| path: artifacts | |
| - name: 📊 Comprobar documentación | |
| # JetBrains Open Source | |
| # Apache-2.0 | |
| # https://github.com/JetBrains/writerside-checker-action | |
| uses: JetBrains/writerside-checker-action@v1 | |
| with: | |
| instance: ${{ env.INSTANCE }} | |
| publicar: | |
| name: 🌐 Publicar Web | |
| if: github.repository == 'TeenBiscuits/Pro2324' | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: [ construir, comprobar ] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: ⬇️ Descargar artefacto | |
| # GitHub Actions | |
| # MIT | |
| # https://github.com/actions/download-artifact | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: docs | |
| path: artifacts | |
| - name: 🗃️ Descomprimir artefacto | |
| 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 | |
| - name: 💅 Archivos personalizados | |
| 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@v4 | |
| - name: 📦 Empaquetar y subir artefacto de Pages | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: dir | |
| - name: 📖 Implementar en GitHub Pages | |
| # GitHub Actions | |
| # MIT | |
| # https://github.com/actions/deploy-pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |
| publicar-indexes: | |
| name: 🔎 Algolia Index | |
| if: github.repository == 'TeenBiscuits/Pro2324' | |
| needs: [ construir, comprobar, publicar ] | |
| runs-on: ubuntu-latest | |
| container: | |
| image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3 | |
| steps: | |
| - name: ⬇️ Descargar artefacto | |
| # GitHub Actions | |
| # MIT | |
| # https://github.com/actions/download-artifact | |
| 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: | | |
| 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 ] | |
| name: 🔎 Bing IndexNow | |
| if: github.repository == 'TeenBiscuits/Pro2324' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: ⬆️ Subir Sitemap | |
| # Bojie Yang | |
| # MIT | |
| # https://github.com/bojieyang/indexnow-action | |
| uses: bojieyang/indexnow-action@v2 | |
| with: | |
| sitemap-location: 'https://pro2324.pablopl.dev/sitemap.xml' | |
| key: ${{ secrets.INDEXNOW_KEY }} | |
| key-location: 'https://pro2324.pablopl.dev/${{ secrets.INDEXNOW_KEY }}.txt' | |
| endpoint: www.bing.com # Es el default | |
| failure-strategy: error | |
| google-indexing: | |
| needs: [ construir, comprobar, publicar ] | |
| name: 🔎 Google Index | |
| if: github.repository == 'TeenBiscuits/Pro2324' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: ⬆️ Subir Urls | |
| # Robin Genz | |
| # MIT | |
| # https://github.com/robingenz/google-indexing-action | |
| uses: robingenz/[email protected] | |
| with: | |
| siteUrl: 'pro2324.pablopl.dev' | |
| gcpServiceAccountKey: ${{ secrets.GCP_SA_KEY }} |