@@ -110,150 +110,3 @@ jobs:
110
110
if : startsWith(github.ref, 'refs/tags/')
111
111
with :
112
112
files : ./ci-artifacts/AppManifest/AppManifest.json
113
-
114
- release-documentation :
115
- name : Generate release documentation
116
- runs-on : ubuntu-latest
117
- needs : initialize-matrix
118
- strategy :
119
- matrix :
120
- component : ${{ fromJson(needs.initialize-matrix.outputs.deployment-matrix) }}
121
- env :
122
- TEST_RESULT_FOLDER_NAME : test-results
123
- steps :
124
- - uses : actions/checkout@v3
125
-
126
- - name : Clone Release Documentation Action repository
127
- uses : actions/checkout@v3
128
- with :
129
- repository : eclipse-velocitas/release-documentation-action
130
- path : " ./.github/actions"
131
-
132
- - uses : actions/setup-node@v3
133
- with :
134
- node-version : " 18"
135
- check-latest : true
136
-
137
- - name : Conditional input event value
138
- uses : haya14busa/action-cond@v1
139
- id : condval
140
- with :
141
- cond : ${{ !github.event.inputs.name }}
142
- if_true : ${{ github.event.inputs.name }}
143
- if_false : ${{ github.sha }}
144
-
145
- - name : Wait for CI workflow to succeed
146
- uses :
fountainhead/[email protected]
147
- with :
148
- checkName : Run Integration Tests (${{ matrix.component.Name }})
149
- token : ${{ secrets.GITHUB_TOKEN }}
150
- timeoutSeconds : 600
151
- intervalSeconds : 10
152
-
153
- - name : Download artifact from CI workflow
154
- uses : dawidd6/action-download-artifact@v2
155
- with :
156
- workflow : ci.yml
157
- workflow_conclusion : success
158
- commit : ${{ steps.condval.outputs.value }}
159
- path : .vehicleApp/Documentation/Inbox
160
-
161
- - name : Render documentation (test-results)
162
- uses : ./.github/actions/render
163
- with :
164
- inboxPath : .vehicleApp/Documentation/Inbox/test-results
165
- outboxPath : .vehicleApp/Documentation/Outbox
166
- templatePath : ./.github/actions/templates
167
-
168
- - name : Upload generated documentation as an artifacts
169
- uses : actions/upload-artifact@v3
170
- if : always()
171
- with :
172
- name : generated-documentation
173
- path : |
174
- .vehicleApp/Documentation/Outbox/
175
- - name : zip
176
- run : |
177
- zip -r .vehicleApp/Documentation/release-documentation-md.zip .vehicleApp/Documentation/Outbox
178
- - name : Upload assets
179
- uses : softprops/action-gh-release@v1
180
- if : startsWith(github.ref, 'refs/tags/')
181
- with :
182
- files : |
183
- .vehicleApp/Documentation/release-documentation-md.zip
184
- env :
185
- GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
186
-
187
- - name : Setup Hugo
188
- uses : peaceiris/actions-hugo@v2
189
- with :
190
- hugo-version : " 0.89.4"
191
- extended : true
192
-
193
- - name : Set tags output
194
- id : vars
195
- run : echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT
196
-
197
- - name : Check output
198
- env :
199
- RELEASE_VERSION : ${{ steps.vars.outputs.tag }}
200
- run : |
201
- echo $RELEASE_VERSION
202
- echo ${{ steps.vars.outputs.tag }}
203
-
204
- - name : Create and Add reports to hugo static html site
205
- run : |
206
- hugo new site hugo
207
-
208
- cp ./README.md ./hugo/content/_index.md
209
-
210
- mkdir ./hugo/content/documentation
211
- mkdir ./hugo/content/reports
212
-
213
- cp ./README.md ./hugo/content/documentation/_index.md
214
- sed -i '1d' hugo/content/documentation/_index.md
215
- sed -i '1s/^/---\ntitle: "VehicleApp using python"\ndraft: false\n---\n/' hugo/content/documentation/_index.md
216
-
217
- cp .vehicleApp/Documentation/Outbox/* ./hugo/content/reports
218
-
219
- sed -i '1,13d' hugo/content/reports/*.md
220
- sed -i '1s/^/---\ntitle: "Code Coverage Test"\ndraft: false\n---\n/' hugo/content/reports/CodeCoverage-*.md
221
- sed -i '1s/^/---\ntitle: "Unit Test Results"\ndraft: false\n---\n/' hugo/content/reports/UnitTest-*.md
222
- cat hugo/content/reports/VulnerabilityScan-*.md > hugo/content/reports/vulnerability-scan-results.md
223
- sed -i '1s/^/---\ntitle: "Vulnerability Scan Results"\ndraft: false\n---\n/' hugo/content/reports/vulnerability-scan-results.md
224
- rm hugo/content/reports/VulnerabilityScan-*.md
225
-
226
- mkdir ./hugo/config
227
- mkdir ./hugo/config/_default
228
- mkdir ./hugo/config/pages
229
-
230
- echo $'languageCode = "en-us"\ntitle = "Release Documentation - @tag"\n\nbaseURL = "http://example.org/"\n\n# Keep uglyURLs for now, as this provides the best out of the box support for rendering markdown images in VSCode preview and Hugo\n# Link: https://gohugo.io/content-management/urls/#ugly-urls\nuglyURLs = "true"\n\nenableGitInfo = true\n\ntheme = "hugo-geekdoc"\n\n# Geekdoc required configuration\npygmentsUseClasses = true\npygmentsCodeFences = true\ndisablePathToLower = true\n\n[markup]\ndefaultMarkdownHandler = "goldmark"\n\n[markup.goldmark.renderer]\nunsafe = true\n\n[markup.tableOfContents]\n ordered= false\n startLevel= 1\n endLevel= 3\n\n[params]\ngeekdocRepo = "https://github.com/eclipse-velocitas/vehicle-app-python-template"\ngeekdocEditPath = "edit/main/hugo/content"\ngeekdocCollapseSection = true\n' > ./hugo/config/_default/config.toml
231
- echo $'# Hugo-Geekdoc Theme Config\n\nbaseURL = "https://fantastic-fiesta-da4ab8e5.pages.github.io/"\n\ntheme = "hugo-geekdoc"\n\nenableGitInfo = false\n\npluralizeListTitles = false\npygmentsUseClasses = true\n\n[markup]\n defaultMarkdownHandler = "goldmark"\n\n[markup.highlight]\n anchorLineNos = false\n codeFences = true\n guessSyntax = false\n hl_Lines = ""\n lineAnchors = ""\n lineNoStart = 1\n lineNos = true\n lineNumbersInTable = true\n noClasses = false\n style = "paraiso-dark"\n tabWidth = 4\n\n[markup.tableOfContents]\n endLevel = 3\n ordered = false\n startLevel = 1\n\n[markup.goldmark.extensions]\n typographer = true\n\n[markup.goldmark.renderer]\n unsafe = true\n\n# Disable geekdoc default theme settings\n[params]\ngeekdocRepo = ""\ngeekdocEditPath = ""\n# disable non-working search when serving from local file system\ngeekdocSearch = false\n' > ./hugo/config/pages/config.toml
232
-
233
- mkdir hugo/data/menu
234
- echo "---" > ./hugo/data/menu/extra.yaml
235
- printf "header:\n - name: GitHub\n ref: https://github.com/eclipse-velocitas/vehicle-app-python-template\n icon: gdoc_github\n external: true\n" >> ./hugo/data/menu/extra.yaml
236
-
237
- echo "---" > ./hugo/data/menu/more.yaml
238
- printf 'more:\n - name: Releases\n ref: "https://github.com/eclipse-velocitas/vehicle-app-python-template/releases"\n external: true\n icon: "gdoc_download"\n - name: "View Source"\n ref: "https://github.com/eclipse-velocitas/vehicle-app-python-template/tree/@tag"\n external: true\n icon: "gdoc_github"\n' >> ./hugo/data/menu/more.yaml
239
-
240
- sed -i -e 's/@tag/${{ steps.vars.outputs.tag }}/g' ./hugo/config/_default/config.toml
241
- sed -i -e 's/@tag/${{ steps.vars.outputs.tag }}/g' ./hugo/data/menu/more.yaml
242
-
243
- - name : Build
244
- working-directory : ${{github.workspace}}/hugo
245
- env :
246
- GEEKDOC_THEME_VERSION : 0.21.1
247
- # hugo --minify not fully supported by hugo-geekdoc theme
248
- run : |
249
- echo "Download theme hugo-geekdoc v${GEEKDOC_THEME_VERSION}"
250
- mkdir -p themes/hugo-geekdoc/
251
- curl -L https://github.com/thegeeklab/hugo-geekdoc/releases/download/v${GEEKDOC_THEME_VERSION}/hugo-geekdoc.tar.gz | tar -xz -C themes/hugo-geekdoc/ --strip-components=1
252
- echo "Build release documentation for GitHub Pages"
253
- hugo -d ./public --environment=pages
254
- - name : Publish to GH Pages
255
- uses : peaceiris/actions-gh-pages@v3
256
- with :
257
- github_token : ${{ secrets.GITHUB_TOKEN }}
258
- publish_dir : ${{github.workspace}}/hugo/public
259
- publish_branch : gh_pages
0 commit comments