PoC/.github/workflows/Pipeline.yml at master · PLC2/PoC · 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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
name: Verify PoC and Generate Documentation

on:
  push:
  pull_request:

jobs:
  Prepare:
    uses: pyTooling/Actions/.github/workflows/PrepareJob.yml@r6
    with:
      main_branch:    'master'
      release_branch: 'master'

  Simulate:
    uses: ./.github/workflows/Simulate.yml
    strategy:
      fail-fast: false
      matrix:
        include:
          - { simulator: 'nvc',  backend: '',      version: 'latest', can-fail: false }
#          - { simulator: 'ghdl', backend: 'mcode', version: 'latest', can-fail: false }
          - { simulator: 'ghdl', backend: 'llvm',  version: 'latest', can-fail: false }
    with:
      simulator:    ${{ matrix.simulator }}
      ghdl-version: ${{ matrix.version }}
      ghdl-backend: ${{ matrix.backend }}
      nvc-version:  ${{ matrix.version }}
      can-fail:     ${{ matrix.can-fail }}

  PublishTestResults:
    uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@r6
    needs:
      - Simulate
#    if: success() || failure()
    with:
      unittest_artifacts_pattern: 'PoC-Report-XML-*'
      testsuite-summary-name:     'The PoC Library'
      merge-input-dialect:        'Any-JUnit'
      merged_junit_filename:      'unittest.xml'
      merged_junit_artifact:      'PoC-Report-XML'
      dorny:                      ${{ inputs.dorny }}
#      codecov:                    ${{ inputs.codecov }}
#    secrets:
#      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

  IntermediateCleanUp:
    name: 🗑️ Intermediate Artifact Cleanup
    runs-on: 'ubuntu-24.04'
    needs:
      - Simulate
      - PublishTestResults
#    if: success() || failure()
    steps:
      - name: 🗑️ Delete YAML artifacts from matrix jobs
        uses: geekyeggo/delete-artifact@v5
        continue-on-error: true
        with:
          name: |
            OSVVM-Report-YAML-*
            PoC-Report-YAML-*

      - name: 🗑️ Delete JUnit XML artifacts from matrix jobs
        uses: geekyeggo/delete-artifact@v5
        continue-on-error: true
        with:
          name: |
            OSVVM-Report-XML-*
            PoC-Report-XML-*

  Documentation:
    uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r6
    needs:
      - PublishTestResults
#    if: success() || failure()
    with:
      requirements:          '-r docs/requirements.txt'
      doc_directory:         'docs'
      unittest_xml_artifact: 'PoC-Report-XML'
      html_artifact:         'PoC-HTML'
      latex_artifact:        'PoC-LaTeX'

  Test:
    runs-on: 'ubuntu-24.04'
    needs:
      - Simulate
      - PublishTestResults
      - Documentation
#    if: success() || failure()
    steps:
      - run: |
          printf "Simulate:           '%s'\n" "${{ needs.Simulate.result }}"
          printf "PublishTestResults: '%s'\n" "${{ needs.PublishTestResults.result }}"
          printf "Documentation:      '%s'\n" "${{ needs.Documentation.result }}"

  PDFDocumentation:
    uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@dev
    needs:
      - Documentation
    if: (success() || failure()) && needs.Documentation.result == 'success'
    with:
      document:       'The PoC-Library'
      latex_artifact: 'PoC-LaTeX'
      pdf_artifact:   'PoC-PDF'
      can-fail:       'true'

  PublishToGitHubPages:
    uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r6
    needs:
      - Documentation
      - Simulate
#    if: (success() || failure()) && needs.Documentation.result == 'success'
    with:
      doc:      'PoC-HTML'
#      coverage: 'PoC-Coverage-HTML'

  AutoTag:
    uses: pyTooling/Actions/.github/workflows/TagReleaseCommit.yml@r6
    needs:
      - Prepare
      - PublishToGitHubPages
    if: needs.Prepare.outputs.is_release_commit == 'true' && github.event_name != 'schedule'
    permissions:
      contents: write  # required for create tag
      actions:  write  # required for trigger workflow
    with:
      version:  ${{ needs.Prepare.outputs.version }}
      auto_tag: ${{ needs.Prepare.outputs.is_release_commit }}

  Release:
    uses: pyTooling/Actions/.github/workflows/PublishReleaseNotes.yml@r6
    needs:
      - PublishToGitHubPages
    if: needs.Prepare.outputs.is_release_tag == 'true'
    permissions:
      contents: write
      actions:  write
    with:
      prerelease: true
      replacements: |
        poc=${{ needs.Prepare.outputs.version }}
      tag: ${{ needs.Prepare.outputs.version }}
      description: |
        # The PoC-Library %poc%
      inventory-json: "inventory.json"
      inventory-version: ${{ needs.Prepare.outputs.version }}
      assets: |

    secrets: inherit