diff --git a/.github/workflows/deploy-website.yml b/.github/workflows/deploy-website.yml new file mode 100644 index 0000000..d35857a --- /dev/null +++ b/.github/workflows/deploy-website.yml @@ -0,0 +1,154 @@ +name: Deploy Website +on: + push: + branches: + - main + - master + - dev/main + paths: + - 'Writerside/**' + - '.github/workflows/deploy-website.yml' + + tags-ignore: + - v*.**.** + # Specify to run a workflow manually from the Actions tab on GitHub + workflow_dispatch: + + +# Gives the workflow permissions to clone the repo and create a page deployment +permissions: + id-token: write + pages: write + +env: + # Name of module and id separated by a slash + INSTANCE: Writerside/ob + INSTANCE_NAME: ob + # Replace HI with the ID of the instance in capital letters + ARTIFACT: webHelpOB2-all.zip + # Writerside docker image version + DOCKER_VERSION: 241.16003 + # Add the variable below to upload Algolia indexes + # Replace HI with the ID of the instance in capital letters + ALGOLIA_ARTIFACT: algolia-indexes-OB.zip + ALGOLIA_APP_NAME: VLLZ4JZE8Z + ALGOLIA_INDEX_NAME: ob-doc + +jobs: + build: + runs-on: ubuntu-latest + outputs: + config_json: ${{ steps.output-config-json.outputs.config_json }} + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Build Writerside docs using Docker + 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@v3 + with: + name: docs + path: | + artifacts/${{ env.ARTIFACT }} + artifacts/report.json + retention-days: 7 + + # Add the step below to upload Algolia indexes + - name: Upload algolia-indexes + uses: actions/upload-artifact@v3 + with: + name: algolia-indexes + path: artifacts/${{ env.ALGOLIA_ARTIFACT }} + retention-days: 7 + + - name: Unzip artifact + run: unzip -O UTF-8 -qq artifacts/${{ env.ARTIFACT }} -d dir + + - name: Output documentation config.json + id: output-config-json + run: | + echo "config_json=$(cat dir/config.json)" >> $GITHUB_OUTPUT + + # 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@v1 + with: + name: docs + path: artifacts + + - name: Test documentation + uses: JetBrains/writerside-checker-action@v1 + with: + instance: ${{ env.INSTANCE }} + + deploy: + 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@v3 + with: + name: docs + + - name: Unzip artifact + run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir + + - name: Setup Pages + uses: actions/configure-pages@v2 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: dir + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 + + # https://www.jetbrains.com/help/writerside/configure-search.html + publish-indexes: + # Requires the build-job results + needs: [build, test] + runs-on: ubuntu-latest + container: + image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3 + + env: + + CONFIG_JSON_VERSION: ${{ fromJSON(needs.build.outputs.config_json).productVersion }} + + steps: + - name: Download artifact + uses: actions/download-artifact@v3 + with: + name: algolia-indexes + + + - name: Unzip artifact + run: | + unzip -O UTF-8 -qq ${{ env.ALGOLIA_ARTIFACT }} -d algolia-indexes + 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.INSTANCE_NAME}} \ + --version ${{env.CONFIG_JSON_VERSION}} \ + --index-directory algolia-indexes/ \ + 2>&1 | tee algolia-update-index-log.txt diff --git a/README.md b/README.md index d923b2f..ecd896a 100644 --- a/README.md +++ b/README.md @@ -277,14 +277,18 @@ public class MyApp { ## License ``` -This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General -Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) +This program is free software: you can redistribute it and/or +modify it under the terms of the GNU Lesser General +Public License as published by the Free Software Foundation, +either version 3 of the License, or (at your option) any later version. -This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied -warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more -details. +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied +warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +See the GNU Lesser General Public License for more details. -You should have received a copy of the GNU Lesser General Public License along with this program. +You should have received a copy of the GNU Lesser General Public +License along with this program. If not, see . ``` diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml index 997a24f..7652907 100644 --- a/Writerside/cfg/buildprofiles.xml +++ b/Writerside/cfg/buildprofiles.xml @@ -16,15 +16,16 @@ false head-script.html VLLZ4JZE8Z - qg-doc + ob-doc e60d9ee16618a0ad3a338ecc73cb840e - http://component-qqguild.simbot.forte.love + https://simple-robot.github.io/simbot-component-onebot - + false +