ledger-secure-sdk/.github/workflows/documentation.yml at 7e2a008e75f0a93a9656733b2f0bea8229537b17 · LedgerHQ/ledger-secure-sdk · 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
name: Documentation generation & update

on:
  push:
    branches:
      - master

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

concurrency:
  group: "pages"
  # false: queue new runs instead of cancelling the in-progress one, to avoid
  # leaving GitHub Pages in a broken state if a deployment is interrupted.
  cancel-in-progress: false

jobs:
  generate:
    name: Generate the documentation
    runs-on: ubuntu-latest
    steps:
      - name: Clone
        uses: actions/checkout@v6
        with:
          fetch-depth: 0
      - name: Install APT dependencies
        run: |
          sudo apt-get update
          sudo apt-get install graphviz doxygen
      - name: Generate Wallet documentation
        run: |
          make doc
          mkdir -p build/doc/site/wallet
          cp -a build/doc/html/. build/doc/site/wallet/

      - name: Generate Nano documentation
        run: |
          TARGET=nanox make doc
          mkdir -p build/doc/site/nano
          cp -a build/doc/html/. build/doc/site/nano/

      - name: Create landing page
        run: |
          cp doc/landing.html build/doc/site/index.html

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: build/doc/site/

  deploy:
    name: Deploy the documentation on Github pages
    runs-on: ubuntu-latest
    needs: generate
    # Safety guard: keep deployment restricted to master even if triggers change later.
    if: github.ref == 'refs/heads/master'
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4