leanVM-b/.github/workflows/doc.yml at main · leanEthereum/leanVM-b · 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
name: Documentation PDF

on:
  push:
    branches: [ "main" ]
    paths:
      - 'doc/leanvm/**'
      - 'doc/xmss/**'
      - 'doc/images/**'
      - '.github/workflows/doc.yml'
  pull_request:
    paths:
      - 'doc/leanvm/**'
      - 'doc/xmss/**'
      - 'doc/images/**'
      - '.github/workflows/doc.yml'
  workflow_dispatch:

concurrency:
  group: doc-${{ github.ref }}
  cancel-in-progress: true

jobs:
  check-pdf:
    if: github.event_name == 'pull_request'
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@v4
      - name: Compile LaTeX
        uses: xu-cheng/latex-action@v3
        with:
          working_directory: doc/leanvm
          root_file: main.tex
      - name: Fail on an undefined reference or citation
        run: |
          ! grep -qE 'Reference .* undefined|Citation .* undefined|multiply defined' doc/leanvm/.build/main.log
      - name: Compile XMSS specification
        uses: xu-cheng/latex-action@v3
        with:
          working_directory: doc/xmss
          root_file: main.tex
      - name: Fail on an undefined XMSS reference or citation
        run: |
          ! grep -qE 'Reference .* undefined|Citation .* undefined|multiply defined' doc/xmss/.build/main.log

  build-pdf:
    if: github.event_name != 'pull_request'
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
      - name: Compile LaTeX
        uses: xu-cheng/latex-action@v3
        with:
          working_directory: doc/leanvm
          root_file: main.tex
      - name: Compile XMSS specification
        uses: xu-cheng/latex-action@v3
        with:
          working_directory: doc/xmss
          root_file: main.tex
      - name: Compile SPHINCS specification
        uses: xu-cheng/latex-action@v3
        with:
          working_directory: doc/sphincs
          root_file: main.tex
      - name: Name the artifacts
        run: |
          cp doc/leanvm/.build/main.pdf leanVM.pdf
          cp doc/xmss/.build/main.pdf XMSS.pdf
          cp doc/sphincs/.build/main.pdf SPHINCS.pdf
      - name: Publish PDFs as release assets
        uses: softprops/action-gh-release@v2
        with:
          tag_name: doc-latest
          name: leanVM documentation
          body: |
            Auto-built on every push to `main`.

            `leanVM.pdf` contains the leanVM specification.
            `XMSS.pdf` contains the XMSS specification.
            `SPHINCS.pdf` contains the SPHINCS specification.
          make_latest: false
          files: |
            leanVM.pdf
            XMSS.pdf
            SPHINCS.pdf