docs.yaml

name: Docs

on:
    workflow_run:
        workflows: ["Release"]
        types:
            - completed
        branches: ["release"]

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

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

env:
    CARGO_TERM_COLOR: always

jobs:
    build_docs:
        if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
        name: Build Docs
        runs-on: self-hosted
        steps:
            - name: Checkout repository
              uses: actions/checkout@v4
              with:
                  ref: release
            - name: Setup Rust
              uses: dtolnay/rust-toolchain@stable
            - name: Configure cache
              uses: Swatinem/rust-cache@v2
            - name: Setup pages
              id: pages
              uses: actions/configure-pages@v5
            - name: Clean docs folder
              run: cargo clean --doc
            - name: Build docs
              run: cargo doc --no-deps
            - name: Add redirect
              run: echo '<meta http-equiv="refresh" content="0;url=hip_rs/index.html">' > target/doc/index.html
            - name: Remove lock file
              run: rm target/doc/.lock
            - name: Upload artifact
              uses: actions/upload-pages-artifact@v3
              with:
                  path: target/doc

    deploy_docs:
        name: Deploy Docs
        environment:
            name: github-pages
            url: ${{ steps.deployment.outputs.page_url }}
        runs-on: self-hosted
        needs: build_docs
        if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
        permissions:
            pages: write
            id-token: write
        steps:
            - name: Deploy to GitHub Pages
              id: deployment
              uses: actions/deploy-pages@v4