doc.yml

name: Rust docs

on:
  push:
    branches:
      - develop

jobs:
  cargodoc:
    name: Cargodoc
    runs-on: ubuntu-latest
    
    steps:
      - uses: actions/checkout@v3
      - name: Rust toolchain
        uses: actions-rs/toolchain@v1
        with:
          toolchain: nightly
          override: true
          profile: minimal
      - name: Generate docs
        run: RUSTDOCFLAGS="--enable-index-page" cargo doc --no-deps -Zrustdoc-map
        
      - name: Create CNAME
        run: |
          echo 'rustdoc.falconmc.org' > target/doc/CNAME
          
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: target/doc
  
  # Deploy job
  deploy:
    # Add a dependency to the build job
    needs: cargodoc

    # 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