matrix-rust-sdk

name: Documentation

on:

  push:

    branches: [main]

  pull_request:

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true

permissions:

  contents: read

  pages: write

  id-token: write

jobs:

  docs:

    name: All crates

    runs-on: ubuntu-latest

    steps:

      - name: Checkout repository

        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6

        with:

          persist-credentials: false

      - name: Install protoc

        uses: taiki-e/install-action@b550161ef8a7bc4f2a671c0b03a18ac9ccedea1e # v2.79.1

        with:

          tool: protoc@3.20.3

      - name: Install Rust

        uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9 # v1

        with:

          toolchain: nightly-2026-02-26

      - name: Install Node.js

        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6

        with:

          node-version: 20

      - name: Load cache

        uses: Swatinem/rust-cache@c19371144df3bb44fab255c43d04cbc2ab54d1c4 # v2.9.1

        with:

          save-if: ${{ github.ref == 'refs/heads/main' }}

      # Keep in sync with xtask docs

      - name: Build documentation

        env:

          RUSTDOCFLAGS: "--enable-index-page -Zunstable-options --cfg docsrs -Dwarnings"

        run:

          cargo doc --no-deps --workspace --features docsrs --exclude=xtask

      - name: Upload artifact

        if: github.event_name == 'push' && github.ref == 'refs/heads/main'

        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0

        with:

          path: './target/doc/'

      - name: Deploy to GitHub Pages

        if: github.event_name == 'push' && github.ref == 'refs/heads/main'

        id: deployment

        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0