Merge pull request #27 from arkedge/update-README #13
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation | |
| on: | |
| push: | |
| branches: ["main"] | |
| paths-ignore: | |
| - client-ui/** | |
| - .github/workflows/client-ui.yml | |
| pull_request: | |
| branches: ["main"] | |
| paths-ignore: | |
| - client-ui/** | |
| - .github/workflows/client-ui.yml | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4.2.2 | |
| - uses: arduino/setup-protoc@v3.0.0 | |
| - name: Install protoc-gen-doc | |
| run: | | |
| mkdir "${GITHUB_WORKSPACE}/bin" | |
| curl -sSfL "https://github.com/pseudomuto/protoc-gen-doc/releases/download/v${PROTOC_GEN_DOC_VERSION}/protoc-gen-doc_${PROTOC_GEN_DOC_VERSION}_linux_amd64.tar.gz" | tar -xzC "${GITHUB_WORKSPACE}/bin" | |
| echo "${GITHUB_WORKSPACE}/bin" >> "$GITHUB_PATH" | |
| env: | |
| # renovate: datasource=github-releases depName=pseudomuto/protoc-gen-doc | |
| PROTOC_GEN_DOC_VERSION: "1.5.1" | |
| - uses: peaceiris/actions-mdbook@v2.0.0 | |
| with: | |
| # renovate: datasource=crate depName=mdbook | |
| mdbook-version: "0.4.40" | |
| - name: Generate proto.md from proto files | |
| run: protoc -I proto --doc_out=./docs --doc_opt=markdown,proto.md $(find proto -name "*.proto" | sort) | |
| - run: mdbook build | |
| - uses: actions/upload-pages-artifact@v3.0.1 | |
| with: | |
| path: book | |
| deploy: | |
| needs: build | |
| if: github.ref_name == 'main' | |
| permissions: | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/deploy-pages@v4.0.5 | |
| id: deployment |