CommonEnergySystemModel/.github/workflows/docs.yml at main · G-PST/CommonEnergySystemModel · 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: Deploy documentation

on:
  push:
    branches: [main]
  workflow_dispatch:

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

concurrency:
  group: pages
  cancel-in-progress: true

jobs:
  build:
    name: Build documentation
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"
          cache: pip

      - uses: actions/setup-node@v4
        with:
          node-version: "20"

      - name: Install Python dependencies
        run: |
          pip install -e ".[docs]"
          git clone https://github.com/Netbeheer-Nederland/linkml-asciidoc-generator.git /tmp/linkml-asciidoc-generator
          pip install -e /tmp/linkml-asciidoc-generator

      - name: Install Node dependencies
        run: npm ci

      - name: Generate schema AsciiDoc from LinkML
        run: |
          python -m linkml_asciidoc_generator.main "model/cesm_v0.1.0.yaml" -o "artifacts/documentation/modules/schema"
          mkdir -p artifacts/documentation/modules/schema/pages/enumeration
          echo '= Duration' > artifacts/documentation/modules/schema/pages/enumeration/Duration.adoc
          echo '' >> artifacts/documentation/modules/schema/pages/enumeration/Duration.adoc
          echo 'Duration is an ISO 8601 duration type (xsd:duration).' >> artifacts/documentation/modules/schema/pages/enumeration/Duration.adoc

      - name: Build HTML site with Antora
        run: npx antora antora-playbook.yml

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs

  deploy:
    name: Deploy to GitHub Pages
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4