cargo-doc.yml

# 
name: Deploy static content to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: [main, master]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - uses: dtolnay/rust-toolchain@nightly

      - name: Docs
        run: cargo doc --no-deps --all-features
        env:
          RUSTDOCFLAGS: "--enable-index-page -Zunstable-options"

      - name: Setup Pages
        uses: actions/configure-pages@v3

      # As of v1.0.9, upload-pages-artifact action rejects files with incorrect permissions.
      # In Rust doc's case, .lock is such a file.
      #
      # cf. https://github.com/actions/deploy-pages/issues/188#issuecomment-1597651901
      - name: Remove unnecessary files
        run: rm -f ./target/doc/.lock

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: './target/doc'

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2