docs: update user guide to reference v0.55.0 (#2738) #1830
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: Render and Deploy Docs | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| name: Render and deploy protocol and API docs | |
| timeout-minutes: 30 | |
| runs-on: buildjet-16vcpu-ubuntu-2004 | |
| steps: | |
| - name: Checkout the source code | |
| uses: actions/checkout@v2 | |
| with: | |
| lfs: true | |
| - name: Install Rust toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: nightly-2023-05-15 | |
| override: true | |
| - name: Load Rust caching | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Load get-version action to grab version component of deployment path | |
| uses: battila7/get-version-action@v2 | |
| id: get_version | |
| - name: Print version component of deployment path | |
| run: | | |
| echo ${{ steps.get_version.outputs.version }} | |
| - name: Install mdbook | |
| run: | | |
| cargo install mdbook mdbook-katex mdbook-mermaid | |
| - name: Build software guide | |
| run: | | |
| cd docs/guide && mdbook build | |
| - name: Move software guide to subdirectory | |
| run: | | |
| cd docs/guide | |
| if [ -d "firebase-tmp" ]; then rm -rf firebase-tmp; fi | |
| mkdir firebase-tmp | |
| mv book firebase-tmp/${{ steps.get_version.outputs.version }} | |
| tree firebase-tmp | |
| - name: Deploy software guide to firebase | |
| uses: w9jds/[email protected] | |
| with: | |
| args: deploy | |
| env: | |
| FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }} | |
| PROJECT_ID: penumbra-guide | |
| PROJECT_PATH: docs/guide | |
| - name: Build protocol spec | |
| run: | | |
| cd docs/protocol && mdbook build | |
| - name: Move protocol spec to subdirectory | |
| run: | | |
| cd docs/protocol | |
| if [ -d "firebase-tmp" ]; then rm -rf firebase-tmp; fi | |
| mkdir firebase-tmp | |
| mv book firebase-tmp/${{ steps.get_version.outputs.version }} | |
| tree firebase-tmp | |
| - name: Deploy protocol spec to firebase | |
| uses: w9jds/[email protected] | |
| with: | |
| args: deploy | |
| env: | |
| FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }} | |
| PROJECT_ID: penumbra-protocol | |
| PROJECT_PATH: docs/protocol | |
| - name: Build rustdocs | |
| run: ./deployments/scripts/rust-docs | |
| - name: Move API docs to subdirectory | |
| run: | | |
| cd docs/rustdoc | |
| if [ -d "firebase-tmp" ]; then rm -rf firebase-tmp; fi | |
| mkdir firebase-tmp | |
| mv ../../target/doc firebase-tmp/${{ steps.get_version.outputs.version }} | |
| # Copy in the static index file | |
| cp index.html firebase-tmp/${{ steps.get_version.outputs.version }} | |
| - name: Deploy API docs to firebase | |
| uses: w9jds/[email protected] | |
| with: | |
| args: deploy | |
| env: | |
| FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }} | |
| PROJECT_ID: penumbra-doc | |
| PROJECT_PATH: docs/rustdoc |