aiida-mlip/.github/workflows/docs.yml at 8870adaff2704c77f2c98cac60b1bbcc16fc25de · stfc/aiida-mlip · 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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
name: docs

on:
  push:
    branches: [main]

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  docs-deploy:
    if: github.ref == 'refs/heads/main' && github.repository == 'stfc/aiida-mlip'
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest

    services:
      postgres:
        image: postgres:10
        env:
          POSTGRES_DB: test_aiida
          POSTGRES_PASSWORD: ''
          POSTGRES_HOST_AUTH_METHOD: trust
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5
        ports:
          - 5432:5432
      rabbitmq:
        image: rabbitmq:latest
        ports:
          - 5672:5672

    steps:
      - uses: actions/checkout@v4

      - name: Install uv
        uses: astral-sh/setup-uv@v5
        with:
          version: "0.6.14"
          python-version: "3.12"

      - name: Install pandoc
        uses: pandoc/actions/setup@v1

      - name: Install dependencies
        run: |
          uv sync --group docs
          uv venv janus
          source janus/bin/activate
          uv pip install "janus_core[mace]" matplotlib-inline
          deactivate

      - name: Setup verdi
        run: |
          uv run verdi presto --use-postgres
          uv run verdi code create core.code.installed -n \
             -Y localhost \
             -X janus \
             -L janus \
             -P mlip.sp \
             --prepend-text "source $(pwd)/janus/bin/activate" \
             --append-text "deactivate"

      - name: Build docs
        run: uv run make html
        working-directory: ./docs/

      - name: upload
        uses: actions/upload-pages-artifact@v3
        with:
          # Upload entire repository
          path: './docs/build/html/.'

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