diff --git a/.github/workflows/deploy-website.yml b/.github/workflows/deploy-website.yml index d35857a..ef5110b 100644 --- a/.github/workflows/deploy-website.yml +++ b/.github/workflows/deploy-website.yml @@ -10,7 +10,7 @@ on: - '.github/workflows/deploy-website.yml' tags-ignore: - - v*.**.** + - v** # Specify to run a workflow manually from the Actions tab on GitHub workflow_dispatch: @@ -140,7 +140,6 @@ jobs: with: name: algolia-indexes - - name: Unzip artifact run: | unzip -O UTF-8 -qq ${{ env.ALGOLIA_ARTIFACT }} -d algolia-indexes diff --git a/.github/workflows/test-branch-website.yml b/.github/workflows/test-branch-website.yml new file mode 100644 index 0000000..a08737f --- /dev/null +++ b/.github/workflows/test-branch-website.yml @@ -0,0 +1,73 @@ +name: Test Branch +on: + pull_request: + branches: + - 'dev/**' + paths: + - 'Writerside/**' + - '.github/workflows/deploy-website.yml' + +concurrency: + group: test-branch-website-${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +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 + +jobs: + test-website-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 + + - 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-website-test: + # Requires build job results + needs: test-website-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 }} diff --git a/.github/workflows/test-branch.yml b/.github/workflows/test-branch.yml index 046cb27..037a37b 100644 --- a/.github/workflows/test-branch.yml +++ b/.github/workflows/test-branch.yml @@ -13,7 +13,7 @@ on: - 'gradle/**' concurrency: - group: ${{ github.workflow }}-${{ github.ref }} + group: test-branch-${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true env: