amp-devcontainer/.github/workflows/wc-document-generation.yml at 518ecadc828a7829467cf2d57f3e6d66463f7d06 · philips-software/amp-devcontainer · 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
---
name: Document Generation

on:
  workflow_call:
    inputs:
      is-release:
        default: false
        type: boolean

permissions: {}

jobs:
  generate-documents:
    name: Generate Documents
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - uses: step-security/harden-runner@fa2e9d605c4eeb9fcad4c99c224cee0c6c7f3594 # v2.16.0
        with:
          egress-policy: audit
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false
      - name: Install dependencies
        run: |
          set -Eeuo pipefail

          sudo apt-get update && sudo apt-get install --no-install-recommends -y plantuml
          python -m pip install gherkin-official==38.0.0 sbdl==1.21.3
      - name: Build & Validate SBDL model
        run: sbdl -m compile test/cpp/integration-tests.bats test/cpp/features/*.feature > amp-devcontainer.sbdl
      - name: Create document control context
        env:
          GITHUB_REF_NAME: ${{ github.ref_name }}
          IS_RELEASE: ${{ inputs.is-release }}
        run: |
          set -Eeuo pipefail

          cat > document-control.sbdl <<SBDL
          #!sbdl
          doc_control is aspect {
            description is "Document control metadata"
            custom:version is "$(jq -r '.["."]' .release-please-manifest.json)"
            custom:generated_at is "[@DATE]"
            custom:git_sha is "[@GIT_COMMIT_HASH]"
            custom:git_ref is "${GITHUB_REF_NAME}"
            custom:sbdl_compiler_version is "[@COMPILER_VERSION:0]"
            custom:sbdl_dsl_version is "[@DSL_VERSION:0]"
            custom:is_release is "${IS_RELEASE}"
          }
          SBDL
      - name: 📄 Generate SRS document
        run: sbdl -m template-fill --template docs/templates/software-requirements-specification.md.j2 amp-devcontainer.sbdl document-control.sbdl > software-requirements-specification.md
      - name: 🧪 Generate STP document
        run: sbdl -m template-fill --template docs/templates/software-test-plan.md.j2 amp-devcontainer.sbdl document-control.sbdl > software-test-plan.md
      - name: 🧩 Generate RTM document
        run: sbdl -m template-fill --template docs/templates/requirements-traceability-matrix.md.j2 amp-devcontainer.sbdl document-control.sbdl > requirements-traceability-matrix.md
      - name: 📄 Generate SRS PDF
        uses: docker://pandoc/extra:3.9.0.0-ubuntu@sha256:72afa9c8d3300e5f10c9c4330e101725687f2179bffd912fb859c6d2ae85de62
        with:
          args: --template eisvogel --syntax-highlighting idiomatic --number-sections --output software-requirements-specification.pdf software-requirements-specification.md
      - name: 🧪 Generate STP PDF
        uses: docker://pandoc/extra:3.9.0.0-ubuntu@sha256:72afa9c8d3300e5f10c9c4330e101725687f2179bffd912fb859c6d2ae85de62
        with:
          args: --template eisvogel --syntax-highlighting idiomatic --number-sections --output software-test-plan.pdf software-test-plan.md
      - name: 🧩 Generate RTM PDF
        uses: docker://pandoc/extra:3.9.0.0-ubuntu@sha256:72afa9c8d3300e5f10c9c4330e101725687f2179bffd912fb859c6d2ae85de62
        with:
          args: --template eisvogel --syntax-highlighting idiomatic --number-sections --output requirements-traceability-matrix.pdf requirements-traceability-matrix.md
      - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
        with:
          name: documents
          path: |
            *.pdf
            *.sbdl
            !document-control.sbdl
          retention-days: 2