documentation.yaml

name: Documentation

on:
  push:
    branches: ["main"]
  workflow_dispatch:

concurrency:
  group: "pages"
  cancel-in-progress: true

env:
  CARGO_TERM_COLOR: always

jobs:
  document-deploy:
    name: Document & Deploy

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}axum_server_dual_protocol

    runs-on: ubuntu-latest

    permissions:
      contents: read
      pages: write
      id-token: write

    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install nightly Rust
        run: |
          rustup toolchain install nightly --profile minimal
          rustup default nightly
      - name: Run Rustdoc
        env:
          RUSTDOCFLAGS: --crate-version main
        run: cargo doc --no-deps -Z rustdoc-map -Z rustdoc-scrape-examples
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Fix permissions
        run: |
          chmod -c -R +rX "target/doc" | while read line; do
            echo "::warning title=Invalid file permissions automatically fixed::$line"
          done
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: target/doc
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4