uutils.github.io/.github/workflows/docs.yml

name: Docs

on:
  push:
    branches:
    - main
  pull_request:
    branches:
    - main
  schedule:
  - cron: "0 2 * * *"

jobs:
  user-docs:
    name: generate the user doc
    runs-on: ubuntu-latest
    steps:
    - name: Checkout Coreutils Repository
      uses: actions/checkout@v3
      with:
        repository: uutils/coreutils
        path: './coreutils'
        fetch-depth: 0

    - name: Checkout Findutils Repository
      uses: actions/checkout@v3
      with:
        repository: uutils/findutils
        path: './findutils'
        fetch-depth: 0

    - name: Install `rust` toolchain
      uses: actions-rs/toolchain@v1
      with:
        toolchain: stable
        default: true
        profile: minimal

    - name: Install `libacl`
      run: |
        sudo apt install libacl1-dev

    - name: Download tldr archive
      run: |
        curl https://tldr.sh/assets/tldr.zip --output coreutils/docs/tldr.zip

    - name: Install necessary tools (oranda, mdbook and mdbook-toc)
      uses: taiki-e/install-action@v2
      with:
        tool: oranda,mdbook,mdbook-toc

    - name: Build Coreutils Docs
      run: |
        cd coreutils
        cargo run --bin uudoc --all-features
        oranda build

    - name: Deploy Coreutils Docs
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./coreutils/public/
        destination_dir: coreutils/

    - name: Build Findutils Docs
      run: |
        cd findutils
        oranda build

    - name: Deploy Findutils Docs
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./findutils/public/
        destination_dir: findutils/

    - name: Deploy Homepage
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./homepage

  docs:
    name: generate the dev doc
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v3
      with:
        repository: uutils/coreutils
        path: './coreutils'
        fetch-depth: 0

    - name: Install `rust` toolchain
      uses: actions-rs/toolchain@v1
      with:
        toolchain: stable
        default: true
        profile: minimal

    - name: Build dev documentation
      run: |
        cd coreutils
        cargo doc --no-deps --all-features --workspace

    - name: Deploy Docs
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./coreutils/target/doc
        destination_dir: coreutils/dev/

  build-report:
    name: generate the build report
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v3
      with:
        repository: uutils/coreutils
        path: './coreutils'
        fetch-depth: 0

    - name: Install `rust` toolchain
      uses: actions-rs/toolchain@v1
      with:
        toolchain: nightly
        default: true
        profile: minimal

    - name: Build report
      run: |
        cd coreutils
        cargo +nightly build --timings=html  -Zunstable-options

    - name: Deploy build report
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./coreutils/target/cargo-timings/
        destination_dir: cargo-timings/