Skip to content

build(deps): bump the golang group across 1 directory with 2 updates #255

build(deps): bump the golang group across 1 directory with 2 updates

build(deps): bump the golang group across 1 directory with 2 updates #255

---
# Build and deploy documentation
#
# Sample workflow for building and deploying a mdBook site to GitHub Pages
#
# To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html
#
name: mdbook
on:
# Runs on pushes targeting the default branch
push:
branches: ['main']
tags: ['v*']
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: 'pages'
cancel-in-progress: false
env:
CARGO_TARGET_DIR: mdbook-bin
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Restore cached mdbook
uses: actions/cache/restore@v4
with:
path: ${{ env.CARGO_TARGET_DIR }}
key: mdbook-${{ hashFiles('*', '**/*') }}
restore-keys: |
mdbook-
mdbook
- name: Install mdBook
run: |
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
rustup update
# Cleanup cache
cargo install cargo-cache
cargo cache --autoclean
# Install mdbook with plugins
cargo install \
mdbook \
mdbook-admonish \
mdbook-footnote \
mdbook-katex \
mdbook-pagetoc \
mdbook-template \
mdbook-toc
- name: Store cached mdbook
uses: actions/cache/save@v4
with:
path: ${{ env.CARGO_TARGET_DIR }}
key: mdbook-${{ hashFiles('*', '**/*') }}
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Build with mdBook
run: |
cd docs
mdbook build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/public
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4