crazyflow/.github/workflows/docs.yml at main · learnsyslab/crazyflow · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
name: Docs

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v7

    - name: Install submodules
      run: |
        git submodule update --init --recursive

    - name: Setup pixi
      uses: prefix-dev/setup-pixi@v0.11.3
      with:
        pixi-version: v0.84.1
        cache: true
        environments: docs
        activate-environment: false
        locked: true

    - name: Cache example media
      uses: actions/cache@v6
      with:
        path: .cache/docs-media
        key: docs-media-${{ hashFiles('crazyflow/**', 'examples/**', 'docs/*.py', 'docs/examples/*.md', 'pyproject.toml') }}
        restore-keys: docs-media-

    - name: Build documentation
      run: pixi run -e docs docs-build

    - name: Setup Pages
      uses: actions/configure-pages@v6

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v5
      with:
        path: ./site

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    if: github.ref == 'refs/heads/main'

    steps:
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v5