From 6b256913b09214edc282fc7a253df8e1501954c2 Mon Sep 17 00:00:00 2001 From: xooooooooox Date: Thu, 2 Jan 2025 23:04:21 +0800 Subject: [PATCH] chore: optimize gh actions --- ..._gh_pages.yml => trigger-github-pages.yml} | 2 +- .../trigger-writerside-docs-build.yml | 109 ------------------ 2 files changed, 1 insertion(+), 110 deletions(-) rename .github/workflows/{publish_writerside_gh_pages.yml => trigger-github-pages.yml} (82%) delete mode 100644 .github/workflows/trigger-writerside-docs-build.yml diff --git a/.github/workflows/publish_writerside_gh_pages.yml b/.github/workflows/trigger-github-pages.yml similarity index 82% rename from .github/workflows/publish_writerside_gh_pages.yml rename to .github/workflows/trigger-github-pages.yml index 5860760..4d60042 100644 --- a/.github/workflows/publish_writerside_gh_pages.yml +++ b/.github/workflows/trigger-github-pages.yml @@ -1,4 +1,4 @@ -name: "[Doc] Publish Writerside Pages" +name: "[Pages] Build and deploy Writerside documentation to GitHub Pages" on: push: diff --git a/.github/workflows/trigger-writerside-docs-build.yml b/.github/workflows/trigger-writerside-docs-build.yml deleted file mode 100644 index ae9b1c3..0000000 --- a/.github/workflows/trigger-writerside-docs-build.yml +++ /dev/null @@ -1,109 +0,0 @@ -# see https://www.jetbrains.com/help/writerside/deploy-docs-to-github-pages.html -name: "[Pages] Trigger Build Writerside documentation" - -on: - push: - branches: - - main - - feat/241230-0.7 - paths: [ 'Writerside/*' ] - workflow_dispatch: - -permissions: - contents: read - id-token: write - pages: write - -env: - INSTANCE: 'Writerside/radp' - DOCKER_VERSION: '243.22562' - -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: - instance: ${{ env.INSTANCE }} - artifact: ${{ env.ARTIFACT }} - docker-version: ${{ env.DOCKER_VERSION }} - - - name: Save artifact with build results - uses: actions/upload-artifact@v4 - with: - name: docs - path: | - artifacts/${{ env.ARTIFACT }} - artifacts/report.json - artifacts/${{ env.ALGOLIA_ARTIFACT }} - retention-days: 7 - test: - 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: - instance: ${{ env.INSTANCE }} - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - needs: [build, test] - runs-on: ubuntu-latest - steps: - - name: Download artifacts - uses: actions/download-artifact@v4 - with: - name: docs - path: artifacts - - - name: Unzip artifact - run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.artifact }}" -d dir - - - name: Setup Pages - uses: actions/configure-pages@v4 - - - name: Package and upload Pages artifact - uses: actions/upload-pages-artifact@v3 - with: - path: dir - - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 \ No newline at end of file