docs.yaml

# build and release new docs as a release asset
name: Build Docs
on:
  release:
    types: [created]
jobs:
  doc:
    name: Build Docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      - name: Setup Python
        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
        with:
          python-version: "3.12"
      - name: Install CLI
        run: |
          python -m pip install -e .
      - name: Generate Autodoc
        run: |
          ./reference/_generate.py --debug
          # bundle as tarball without the _generate.py script or .gitignore
          # use `-h` to dereference the changelog link
          tar --exclude "*.py" --exclude '.gitignore' -czf cli-reference.tar.gz -h reference/
      # upload as a release asset
      - name: Upload Autodoc
        env:
          GH_TOKEN: ${{ github.token }}
          GH_REPO: ${{ github.repository }}
        run: gh release upload "${{ github.ref_name }}" cli-reference.tar.gz