docs.yml

name: Documentation

on: [push, pull_request]

jobs:
    build-docs:
        name: Build documentation
        runs-on: ubuntu-20.04
        steps:
          - name: Install prerequisites
            run: |
                sudo apt-get install doxygen ninja-build
                sudo pip3 install meson
          - name: Install mdbook
            run: |
                set -e
                wget -O mdbook.tar.gz https://github.com/rust-lang/mdBook/releases/download/v0.4.20/mdbook-v0.4.20-x86_64-unknown-linux-gnu.tar.gz
                sha512sum --check <<EOF
                bc184123378814c0d28ffb13d88736bcfab64cfabb140f42c331e41f4fd7ea3fee24e480f78fe8f6f3f13bddd57bda7dcc215e6fc7f4a606177903dd10881a74  mdbook.tar.gz
                EOF
                tar xf mdbook.tar.gz
                sudo install -D mdbook /usr/local/bin/mdbook
          - name: Install rsync-ssl
            run: |
                wget https://raw.githubusercontent.com/WayneD/rsync/c3f7414c450faaf6a8281cc4a4403529aeb7d859/rsync-ssl
                sudo install -D rsync-ssl /usr/local/bin/rsync-ssl
          - name: Checkout
            uses: actions/checkout@v2
            with:
              path: src/
          - name: Configure
            run: meson build/ src/ -Dbuild_docs=true
          - name: Build handbook
            run: ninja mdbook
            working-directory: build/
          - name: Build hel reference
            run: ninja hel-api
            working-directory: build/
          - name: Upload handbook artifact
            uses: actions/upload-artifact@v4
            with:
                name: handbook
                path: build/docs/
          - name: Upload hel reference artifact
            uses: actions/upload-artifact@v4
            with:
                name: hel-reference
                path: build/hel-api/html/
          - name: Upload handbook to docs.managarm.org
            if: github.ref == 'refs/heads/master'
            env:
                RSYNC_PASSWORD: ${{ secrets.RSYNC_DOCUMENTATION_PASSWD }}
            run:
                rsync-ssl -a --delete build/docs/ docs@rsync.managarm.org::docs/handbook
          - name: Upload hel reference to rsync.managarm.org
            if: github.ref == 'refs/heads/master'
            env:
                RSYNC_PASSWORD: ${{ secrets.RSYNC_DOCUMENTATION_PASSWD }}
            run:
                rsync-ssl -a --delete build/hel-api/html/ docs@rsync.managarm.org::docs/hel-api