key-docs/.github/workflows/mkdocs.yml at master · KeYProject/key-docs · 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
89
90
91
92
93
94
95
96
97
98
name: Render Pages

on:
  push:
    branches: ["master", "main"]
  pull_request:
    branches:
      - master
      - main
  schedule:
    - cron: "0 2 * * 6"

  workflow_dispatch:

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

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

defaults:
  run:
    shell: bash

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v7
      - uses: actions/setup-python@v7
        with:
          python-version: 3.x
      - name: Prepare system
        run: pip install --user -r requirements.txt

        # Download the generated documentation for variable conditions and proof
        # script commands from the latest successful nightly build of KeYProject/key.
        # All steps are fault-tolerant: if the artifact is unavailable, the site
        # is still built (without the generated reference pages).
      - name: Find latest nightly build run
        id: nightly
        continue-on-error: true
        run: |
          run_id=$(gh run list --repo KeYProject/key \
                          --workflow nightlydeploy.yml \
                          --status success --limit 1 \
                          --json databaseId --jq '.[0].databaseId')
          if [ -n "$run_id" ]; then
            echo "run-id=$run_id" >> "$GITHUB_OUTPUT"
          fi
        env:
          GH_TOKEN: ${{ github.token }}

      - name: Download varcond/script documentation artifact
        continue-on-error: true
        if: steps.nightly.outputs.run-id != ''
        uses: actions/download-artifact@v7
        with:
          name: varcond-script-docs
          path: download/keydocs
          repository: KeYProject/key
          run-id: ${{ steps.nightly.outputs.run-id }}
          github-token: ${{ github.token }}

      - name: Unpack documentation into docs/user
        continue-on-error: true
        run: |
          mkdir -p docs/user/ProofScripts
          if [ -f download/keydocs/key-varcond-script-docs.zip ]; then
            unzip -o -q download/keydocs/key-varcond-script-docs.zip -d docs/user/ProofScripts
          else
            echo "::warning::Generated key documentation not available; skipping."
          fi

      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v6
      - run: mkdocs build -c -d public
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: ./public

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    if: github.ref == 'refs/heads/master'
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5