rust-docs.yml

name: Rust Docs

on:
  push:
    branches: [main]
  pull_request:

env:
  CARGO_TERM_COLOR: always
  RUSTFLAGS: "-C target-feature=+aes,+sse2"

jobs:
  build:
    name: Build Rust docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: dtolnay/rust-toolchain@1.98.0

      - uses: Swatinem/rust-cache@v2

      - name: Build docs
        run: cargo doc --workspace --no-deps

      - name: Add redirect index
        run: echo '<meta http-equiv="refresh" content="0; url=ppvm_traits">' > target/doc/index.html

      - name: Upload artifact
        uses: actions/upload-artifact@v4
        with:
          name: rust-docs
          path: target/doc/

  deploy:
    name: Deploy Rust docs
    needs: build
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    permissions:
      contents: write
    concurrency:
      group: deploy-gh-pages
      cancel-in-progress: false
    steps:
      - uses: actions/checkout@v4

      - uses: actions/download-artifact@v4
        with:
          name: rust-docs
          path: target/doc/

      - uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./target/doc
          destination_dir: rust-api
          keep_files: true