diff --git a/.github/workflows/build-test-docs.yml b/.github/workflows/build-test-docs.yml new file mode 100644 index 00000000..ffe72454 --- /dev/null +++ b/.github/workflows/build-test-docs.yml @@ -0,0 +1,60 @@ +name: Build and test documentation + +on: + pull_request: + paths: + - 'docs/pages/**' + - '.github/workflows/**' + workflow_dispatch: + workflow_call: + +permissions: + id-token: write + pages: write + +env: + INSTANCE: 'kotlinx-rpc/rpc' + ARTIFACT: 'webHelpRPC2-all.zip' + DOCKER_VERSION: '241.15989' + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - 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 }} + location: docs/pages/kotlinx-rpc/ + + - name: Save artifact with build results + uses: actions/upload-artifact@v4 + with: + name: kotlinx-rpc + 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: kotlinx-rpc + path: artifacts + + - name: Test documentation + uses: JetBrains/writerside-checker-action@v1 + with: + instance: ${{ env.INSTANCE }} diff --git a/.github/workflows/build-docs.yml b/.github/workflows/deploy-docs.yml similarity index 63% rename from .github/workflows/build-docs.yml rename to .github/workflows/deploy-docs.yml index 90bd16ff..640307c4 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,4 +1,4 @@ -name: Build documentation +name: Deploy documentation and indexes on: push: @@ -21,46 +21,8 @@ env: CONFIG_JSON_VERSION: '0.1.0' jobs: - build: - runs-on: ubuntu-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - 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 }} - locations: docs/pages/kotlinx-rpc/ - - - name: Save artifact with build results - uses: actions/upload-artifact@v4 - with: - name: kotlinx-rpc - 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: kotlinx-rpc - path: artifacts - - - name: Test documentation - uses: JetBrains/writerside-checker-action@v1 - with: - instance: ${{ env.INSTANCE }} + build-and-test: + uses: ./.github/workflows/build-test-docs.yml deploy: environment: diff --git a/docs/pages/kotlinx-rpc/topics/transport.topic b/docs/pages/kotlinx-rpc/topics/transport.topic index e40966d6..dc593ab6 100644 --- a/docs/pages/kotlinx-rpc/topics/transport.topic +++ b/docs/pages/kotlinx-rpc/topics/transport.topic @@ -13,7 +13,7 @@ encoded RPC messages in kRPC Protocol. This layer is represented by RPCTransport interface. It supports two message formats — string and binary, - and depending on which serialization format you choose, + and depending on which serialization format you choose, one or the other will be used.