ncs-serial-modem/.github/workflows/doc-build-and-publish-zoomin.yml at e0869575260ae1973ba8f77498e68b368e719076 · nrfconnect/ncs-serial-modem · 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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
name: Documentation Build and Publish to Zoomin

on:
  workflow_dispatch:
    inputs:
      documentation_tag:
        type: string
        required: false
        default: "latest"
        description: "Label of the documentation"
      publish_to_prod:
        type: boolean
        default: true
      publish_to_dev:
        type: boolean
        default: true

  workflow_call:
    inputs:
      documentation_tag:
        type: string
        required: true
        default: "latest"
      publish_to_prod:
        type: boolean
        default: true
      publish_to_dev:
        type: boolean
        default: true

env:
  DOXYGEN_VERSION: 1.12.0

jobs:
  doc-build-and-publish:
    env:
      ARCHIVE: "addon-serial_modem-${{inputs.documentation_tag}}.zip"

    runs-on: ubuntu-latest

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

    permissions:
      contents: write

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y python3 python3-pip

      - name: Install Python dependencies
        working-directory: doc
        run: |
          python3 -m pip install -r requirements.txt

      - name: Install Doxygen
        run: |
          wget --no-verbose "https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION//./_}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz"
          tar xf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz
          echo "${PWD}/doxygen-${DOXYGEN_VERSION}/bin" >> $GITHUB_PATH

      - name: Build documentation
        working-directory: doc
        run: |
          doxygen
          sphinx-build -M html . build

          cp custom.properties build/html
          sed -i 's/__VERSION__/'"${{inputs.documentation_tag}}"'/g' build/html/custom.properties

          cp tags.yml build/html
          sed -i 's/__VERSION__/'"${{inputs.documentation_tag}}"'/g' build/html/tags.yml

          cd build/html

          zip -rq "${{env.ARCHIVE}}" .
          ls -lah .

      - name: Upload artifact
        uses: actions/upload-artifact@v4
        with:
          name: doc-build
          if-no-files-found: error
          retention-days: 2
          path: |
            doc/build/html/${{env.ARCHIVE}}

      - name: Prepare Key
        run: |
          mkdir -p ~/.ssh
          ssh-keyscan upload-v1.zoominsoftware.io >> ~/.ssh/known_hosts

          echo "${{ secrets.ZOOMIN_KEY }}" > zoomin_key
          chmod 600 zoomin_key

      - name: Publish documentation - prod
        if: ${{inputs.publish_to_prod}}
        run: |
          sftp -v -i zoomin_key nordic@upload-v1.zoominsoftware.io <<EOF
            cd docs-be.nordicsemi.com/sphinx-html/incoming
            put doc/build/html/${{env.ARCHIVE}}
          EOF

      - name: Publish documentation - dev
        if: ${{inputs.publish_to_dev}}
        run: |
          sftp -v -i zoomin_key nordic@upload-v1.zoominsoftware.io <<EOF
            cd nordic-be-dev.zoominsoftware.io/sphinx-html/incoming
            put doc/build/html/${{env.ARCHIVE}}
          EOF