backend_docs.yml

name: Backend CI - cargo doc

on:
  push:
    branches:
      - master
    paths:
      - '.github/workflows/backend*'
      - 'backend/**'
      - '!frontend/**'
  pull_request:
    paths:
      - '.github/workflows/backend*'
      - 'backend/**'
      - '!frontend/**'

env:
  CARGO_TERM_COLOR: always

defaults:
  run:
    working-directory: ./backend

jobs:
  docs:
    name: Check Documentation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v3

      - name: Install Rust stable toolchain
        uses: actions-rs/toolchain@v1
        with:
          profile: minimal
          toolchain: stable
          override: true

      - name: Rust Cache
        uses: Swatinem/rust-cache@6fd3edff6979b79f87531400ad694fb7f2c84b1f # v2.2.1
        with:
          workspaces: backend

      - name: Check internal documentation links
        run: RUSTDOCFLAGS="--deny broken_intra_doc_links" cargo doc --verbose --workspace --no-deps --document-private-items