mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-04-26 10:11:10 -04:00
46 lines
1.2 KiB
YAML
46 lines
1.2 KiB
YAML
name: Documentation
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
|
|
jobs:
|
|
docs:
|
|
name: All crates
|
|
runs-on: ubuntu-latest
|
|
if: github.event_name == 'push' || !github.event.pull_request.draft
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v2
|
|
|
|
- name: Install Rust
|
|
uses: actions-rs/toolchain@v1
|
|
with:
|
|
profile: minimal
|
|
toolchain: nightly
|
|
override: true
|
|
|
|
- name: Load cache
|
|
uses: Swatinem/rust-cache@v1
|
|
|
|
# Keep in sync with xtask docs
|
|
- name: Build documentation
|
|
uses: actions-rs/cargo@v1
|
|
env:
|
|
# Work around https://github.com/rust-lang/cargo/issues/10744
|
|
CARGO_TARGET_APPLIES_TO_HOST: "true"
|
|
RUSTDOCFLAGS: "--enable-index-page -Zunstable-options --cfg docsrs -Dwarnings"
|
|
with:
|
|
command: doc
|
|
args: --no-deps --workspace --features docsrs
|
|
|
|
- name: Deploy documentation
|
|
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
|
uses: peaceiris/actions-gh-pages@v3
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_dir: ./target/doc/
|
|
force_orphan: true
|