docs.yml

name: Rustdoc
on:
  push:
    branches: [main]
  pull_request:
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.head.label || github.head_ref || github.ref }}
  cancel-in-progress: true
jobs:
  build-docs:
    permissions:
      contents: read
    runs-on: ubuntu-latest-4-cores
    steps:
      - name: Checkout repository
        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac #v4

      - name: Prep build on Ubuntu
        uses: ./.github/actions/prep-ubuntu
        with:
          cache: enabled
          # Cache needs Google credentials:
          GWIP: ${{ secrets.GWIP_SCCACHE }}
          GSA: ${{ secrets.GSA_SCCACHE }}

      - name: Build documentation
        id: build_docs
        run: cargo doc --all --no-deps
        env:
          RUSTDOCFLAGS: "-D warnings"
          RUSTC_WRAPPER: "sccache"

      - name: Build Documentation failed
        if: always() && steps.build_docs.outcome == 'failure'
        run: echo ":::error::cargo doc --all --no-deps failed"
        # Job will stop here and the check will be red if Build documentation failed

      - name: Create Index file
        if: github.ref == 'refs/heads/main'
        run: |
          echo "<meta http-equiv=\"refresh\" content=\"0; url=centrifuge_chain/index.html\">" \ > ./target/doc/index.html

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

  deploy-docs:
    runs-on: ubuntu-latest
    permissions:
      pages: write      # to deploy to Pages
      id-token: write
    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy Docs
        if: github.ref == 'refs/heads/main'
        id: deployment
        uses: actions/deploy-pages@v2