Skip to content

Commit f37f087

Browse files
committed
Documented PublishCoverageResults.
1 parent dd30d0b commit f37f087

File tree

6 files changed

+449
-15
lines changed

6 files changed

+449
-15
lines changed

.github/workflows/ApplicationTesting.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ jobs:
9494
name: ${{ inputs.wheel }}
9595
path: install
9696

97+
# TODO: extract step to an Action so package lists are shared with UnitTesting (and GHDL?)
9798
- name: Compute pacman/pacboy packages
9899
id: pacboy
99100
if: matrix.system == 'msys2'

.github/workflows/PublishCoverageResults.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -138,22 +138,22 @@ jobs:
138138
run: coverage combine --data-file=.coverage coverage/
139139

140140
- name: Report code coverage
141-
run: coverage report --rcfile=pyproject.toml --data-file=.coverage
141+
run: coverage report --rcfile=${{ inputs.coverage_config }} --data-file=.coverage
142142

143143
- name: Convert to XML format (Cobertura)
144144
if: inputs.coverage_xml_artifact != '' || inputs.codecov || inputs.codacy
145-
run: coverage xml --data-file=.coverage
145+
run: coverage xml --rcfile=${{ inputs.coverage_config }} --data-file=.coverage
146146

147147
- name: Convert to JSON format
148148
if: inputs.coverage_json_artifact != ''
149-
run: coverage json --data-file=.coverage
149+
run: coverage json --rcfile=${{ inputs.coverage_config }} --data-file=.coverage
150150

151151
- name: Convert to HTML format
152152
if: inputs.coverage_html_artifact != ''
153153
run: |
154-
coverage html --data-file=.coverage -d report/coverage/html
155-
rm report/coverage/html/.gitignore
156-
tree -pash report/coverage/html
154+
coverage html --rcfile=${{ inputs.coverage_config }} --data-file=.coverage
155+
rm ${{ inputs.coverage_report_html_directory }}/.gitignore
156+
tree -pash ${{ inputs.coverage_report_html_directory }}
157157
158158
- name: 📤 Upload 'Coverage SQLite Database' artifact
159159
uses: pyTooling/upload-artifact@v4

doc/JobTemplate/AllInOne/CompletePipeline.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,41 @@ It can be used for simple Python packages as well as namespace packages.
214214
* :pypi:`wheel`
215215

216216
* :ref:`pyTooling/Actions/.github/workflows/PublishTestResults.yml <JOBTMPL/PublishTestResults>`
217+
218+
* :gh:`actions/checkout`
219+
* :gh:`pyTooling/download-artifact`
220+
221+
* :gh:`actions/download-artifact`
222+
223+
* pip
224+
225+
* :pypi:`pyEDAA.Reports`
226+
227+
* :gh:`dorny/test-reporter`
228+
* :gh:`codecov/test-results-action`
229+
* :gh:`pyTooling/upload-artifact`
230+
231+
* :gh:`actions/upload-artifact`
232+
217233
* :ref:`pyTooling/Actions/.github/workflows/PublishCoverageResults.yml <JOBTMPL/PublishCoverageResults>`
234+
235+
* :gh:`actions/checkout`
236+
* :gh:`pyTooling/download-artifact`
237+
238+
* :gh:`actions/download-artifact`
239+
240+
* pip
241+
242+
* :pypi:`coverage`
243+
* :pypi:`tomli`
244+
245+
* :gh:`pyTooling/upload-artifact`
246+
247+
* :gh:`actions/upload-artifact`
248+
249+
* :gh:`codecov/codecov-action`
250+
* :gh:`codacy/codacy-coverage-reporter-action`
251+
218252
* :ref:`pyTooling/Actions/.github/workflows/SphinxDocumentation.yml <JOBTMPL/SphinxDocumentation>`
219253

220254
* :gh:`actions/checkout`
@@ -252,6 +286,18 @@ It can be used for simple Python packages as well as namespace packages.
252286

253287
* :ref:`pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml <JOBTMPL/PublishToGitHubPages>`
254288
* :ref:`pyTooling/Actions/.github/workflows/PublishOnPyPI.yml <JOBTMPL/PublishOnPyPI>`
289+
290+
* :gh:`pyTooling/download-artifact`
291+
292+
* :gh:`actions/download-artifact`
293+
* :gh:`actions/setup-python`
294+
* :gh:`geekyeggo/delete-artifact`
295+
296+
* pip
297+
298+
* :pypi:`wheel`
299+
* :pypi:`twine`
300+
255301
* :ref:`pyTooling/Actions/.github/workflows/TagReleaseCommit.yml <JOBTMPL/TagReleaseCommit>`
256302

257303
* :gh:`actions/github-script`

doc/JobTemplate/Documentation/LaTeXDocumentation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ latex_artifact
131131
:Required: yes
132132
:Default Value: — — — —
133133
:Possible Values: Any valid artifact name.
134-
:Description: name of the artifact containing the LaTeX document to translate.
134+
:Description: Name of the artifact containing the LaTeX document to translate.
135135

136136

137137
.. _JOBTMPL/LatexDocumentation/Input/document:

0 commit comments

Comments
 (0)