rustdoc-pages.yml

# Publishes docs built off latest git main branch to a GitHub Pages site.
# The docs root will then be served at https://embarkstudios.github.io/spirt/spirt/index.html
#
# You must also go to the Pages settings for your repo and set it to serve from Actions for this to work
name: Publish Docs

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

env:
  CARGO_TERM_COLOR: always

jobs:
  build:
    name: Build Docs

    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v3
      with:
        submodules: true
        # NOTE(eddyb) tags needed for `git describe --tags --always` below.
        fetch-depth: 0
    - name: Setup Rust Env
      uses: actions-rs/toolchain@v1
      with:
        toolchain: nightly
        override: true
    - name: Build Docs
      run: |
        RUSTDOCFLAGS="--cfg docs_build --cfg git_main_docs" \
        GIT_MAIN_COMMIT="$(git rev-parse HEAD)" \
        GIT_MAIN_DESCRIBE="$(git describe --tags --always)" \
        cargo doc --document-private-items
    - name: Setup Pages
      id: pages
      uses: actions/configure-pages@v2
    - name: Upload artifact
      uses: actions/upload-pages-artifact@v1
      with:
        # Upload entire doc folder
        path: './target/doc'

  deploy:
    name: Deploy to Pages

    needs: build

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write      # to deploy to Pages
      id-token: write   # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    # Specify runner + deployment step
    runs-on: ubuntu-latest

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