licensing.yml

name: Cargo licensing

on:
  push:
    branches:
      - main
    paths:
      - ".github/workflows/licensing.yml"
      - "licensing/about.hbs"
      - "licensing/about.toml"
      - "Cargo.lock"
      - "Cargo.toml"

permissions:
  actions: none
  checks: none
  contents: read
  deployments: none
  id-token: write
  issues: none
  packages: none
  pages: write
  pull-requests: none
  repository-projects: none
  security-events: none
  statuses: none

env:
  CARGO_TERM_COLOR: always

jobs:
  licensing:
    name: Generate third party license overview
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Rust latest stable
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: stable
      - uses: Swatinem/rust-cache@v2
      - name: Install "cargo-about"
        run: cargo install --locked cargo-about
      - name: Create "docs" directory (if necessary)
        run: |
          if [[ ! -d docs ]]; then
            mkdir docs
          fi
      - name: Generate third party license overview
        run: cargo-about generate -o docs/licenses.html licensing/about.hbs -c licensing/about.toml
      - uses: actions/upload-pages-artifact@v3
        with:
          path: 'docs'
      - name: Deploy to GitHub Pages
        uses: actions/deploy-pages@v4