edgehog/.github/workflows/docs-workflow.yaml at 00ba01229aff0ab76ba7ac12400caa9f52c3b735 · lusergit/edgehog · 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
#
# This file is part of Edgehog.
#
# Copyright 2021-2026 SECO Mind Srl
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0

name: Edgehog docs generation

# publish Generate and publish docs on pushes on main (or release branches) only
# when backend or frontend files are touched.
on:
  workflow_call:
    inputs:
      release-made:
        required: true
        type: boolean
      release-version:
        type: string
      publish:
        type: boolean
        default: true

defaults:
  run:
    shell: bash

jobs:
  docs:
    runs-on: ubuntu-22.04
    services:
      postgres:
        image: postgres
        env:
          POSTGRES_PASSWORD: postgres
        ports:
          - 5432:5432
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5
    steps:
      - name: Checkout the source
        uses: actions/checkout@v6
        with:
          path: edgehog
          show-progress: false
          fetch-tags: true
      - name: Checkout the docs repository
        uses: actions/checkout@v6
        with:
          repository: edgehog-device-manager/docs
          path: docs
          show-progress: false
      - name: Checkout the interfaces repository
        uses: actions/checkout@v6
        with:
          repository: edgehog-device-manager/edgehog-astarte-interfaces
          path: edgehog-astarte-interfaces
          show-progress: false
      - name: Compute docs version
        id: compute-version
        run: |
          version=$(${{ inputs.release-made }} && echo ${{ inputs.release-version }} || echo "snapshot")
          echo "version=$version" >> $GITHUB_OUTPUT
      - uses: ./edgehog/.github/actions/doc-generate
        with:
          edgehog: edgehog
          docs: docs
          astarte-interfaces: edgehog-astarte-interfaces
          version: ${{ steps.compute-version.outputs.version }}
      - uses: ./edgehog/.github/actions/doc-publish
        if: ${{ inputs.publish }}
        with:
          docs: docs