Skip to content

Allow dist of api-augment to be in the npm package (#3037) #1885

Allow dist of api-augment to be in the npm package (#3037)

Allow dist of api-augment to be in the npm package (#3037) #1885

Workflow file for this run

name: Publish Rust Docs
on:
push:
branches:
- master
jobs:
deploy-docs:
name: Deploy docs
runs-on: bare-metal
steps:
# The protobuf compiler should be pre-installed on bare-metal
#- name: Install tooling
# run: sudo apt-get install -y protobuf-compiler
- name: Check tooling
run: protoc --version
- name: Checkout repository
uses: actions/checkout@v4
# With rustup's nice new toml format, we just need to run rustup show to install the toolchain
# https://github.com/actions-rs/toolchain/issues/126#issuecomment-782989659
- name: Setup Rust toolchain
run: |
rustup override unset
rustup show
- uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-cargo-doc-${{ hashFiles('**/Cargo.lock') }}
- name: Build rustdocs
uses: actions-rs/cargo@v1
env:
CARGO_INCREMENTAL: "0"
with:
command: doc
args: --all --no-deps
# Make an index.html file so we start at the moonbeam_runtime page
# Copied from https://github.com/substrate-developer-hub/rustdocs/blob/master/index.html
- name: Make index.html
run: echo "<meta http-equiv=refresh content=0;url=moonbeam_runtime/index.html>" > ./target/doc/index.html
- name: Deploy documentation
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: ./target/doc