Skip to content

Commit

Permalink
Added build and test docs on PR (#97)
Browse files Browse the repository at this point in the history
* Added build and test docs on PR

* Fix link in docs

* Updated wrong parameter name
  • Loading branch information
Mr3zee authored Jun 13, 2024
1 parent b9211a8 commit bcaa44d
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 42 deletions.
60 changes: 60 additions & 0 deletions .github/workflows/build-test-docs.yml
Original file line number Diff line number Diff line change
@@ -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 }}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build documentation
name: Deploy documentation and indexes

on:
push:
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/kotlinx-rpc/topics/transport.topic
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
encoded RPC messages in kRPC Protocol.
This layer is represented by <code>RPCTransport</code> interface.
It supports two message formats — string and binary,
and depending on which <a anchor="serialization-dsl">serialization</a> format you choose,
and depending on which <a href="configuration.topic" anchor="serialization-dsl">serialization</a> format you choose,
one or the other will be used.</p>

<chapter title="Ktor transport" id="ktor-transport">
Expand Down

0 comments on commit bcaa44d

Please sign in to comment.