Skip to content

docs: document CI option for multi-package changes #65

docs: document CI option for multi-package changes

docs: document CI option for multi-package changes #65

Workflow file for this run

name: Deploy mdBook
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Cache cargo-binstall
uses: actions/cache@v5
with:
path: ~/.cargo/bin/cargo-binstall
key: ${{ runner.os }}-cargo-binstall
- name: Install cargo-binstall
run: |
if [ ! -f ~/.cargo/bin/cargo-binstall ]; then
curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
fi
- name: Setup mdBook
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: '0.4.52'
- name: Install mdbook-admonish
run: |
cargo binstall mdbook-admonish@1.20.0 --no-confirm --force
mdbook-admonish install .
- name: Install mdbook-mermaid
run: |
cargo binstall mdbook-mermaid@0.15.0 --no-confirm --force
mdbook-mermaid install .
- name: Install mdbook-linkcheck
run: cargo binstall mdbook-linkcheck@0.7.7 --no-confirm --force
- name: Build mdBook
run: mdbook build
- name: Upload artifact
uses: actions/upload-pages-artifact@v4
with:
path: ./book/html
deploy:
if: github.ref == 'refs/heads/main' && github.repository_owner == 'tianocore'
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