Update migration guide for #1205 (#1211) #517
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: Generate doc | |
# Triggerred when a new commit is pushed to master | |
on: | |
push: | |
branches: | |
- master | |
jobs: | |
publish-rustdoc-as-ghpages: | |
runs-on: ubuntu-22.04 | |
steps: | |
- uses: actions/checkout@v4 | |
# Show the Rust toolchain we are actually using | |
- run: rustup show | |
- run: cargo --version | |
- name: Append sha to crate version | |
run: | | |
sed -i 's/^version = "[0-9]\+.[0-9]\+.[0-9]\+/&-'${GITHUB_SHA}'/' Cargo.toml | |
- name: Generate rustdoc | |
env: | |
# Override preprocessor.hide.hide in book.toml to hide some chapters. | |
MDBOOK_preprocessor__hide__hide: "true" | |
run: ./.github/scripts/ci-doc.sh | |
- name: Copy docs | |
# docs.mmtk.io is the root for github pages. | |
# mmtk full doc: /api | |
run: | | |
cp -r docs/userguide/book to_publish | |
cp -r target/doc to_publish/api | |
- name: Deploy to Github Page | |
uses: peaceiris/actions-gh-pages@v4 | |
with: | |
personal_token: ${{ secrets.CI_ACCESS_TOKEN }} | |
publish_dir: to_publish | |
publish_branch: gh-pages | |
cname: docs.mmtk.io |