Skip to content

Commit dd67918

Browse files
authored
v0.3.0
2 parents e08c4a5 + 4f4cb62 commit dd67918

File tree

17 files changed

+239
-129
lines changed

17 files changed

+239
-129
lines changed

.github/pull_request_template.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,30 @@
11
# New Features
2-
2+
3+
* tbd
34
* tbd
45

56
# Changes
67

8+
* tbd
79
* tbd
810

911
# Bug Fixes
1012

13+
* tbd
14+
* tbd
15+
16+
# Documentation
17+
18+
* tbd
19+
* tbd
20+
21+
# Unit Tests
22+
23+
* tbd
1124
* tbd
1225

1326
----------
14-
# Related PRs:
27+
# Related Issues and Pull-Requests
1528

1629
* tbd
30+
* tbd

.github/workflows/Pipeline.yml

Lines changed: 129 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -4,121 +4,186 @@ on:
44
push:
55
workflow_dispatch:
66
schedule:
7-
- cron: '0 0 * * 5'
7+
# Every Friday at 22:00 - rerun pipeline to check for dependency-based issues
8+
- cron: '0 22 * * 5'
89

910
jobs:
10-
11-
Params:
11+
UnitTestingParams:
1212
uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
1313
with:
1414
name: pySystemRDLModel
1515

1616
UnitTesting:
1717
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
1818
needs:
19-
- Params
19+
- UnitTestingParams
2020
with:
21-
jobs: ${{ needs.Params.outputs.python_jobs }}
22-
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}
23-
24-
Coverage:
25-
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@dev
26-
needs:
27-
- Params
28-
with:
29-
python_version: ${{ needs.Params.outputs.python_version }}
30-
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
31-
secrets:
32-
codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
21+
jobs: ${{ needs.UnitTestingParams.outputs.python_jobs }}
22+
requirements: "-r tests/unit/requirements.txt"
23+
# pacboy: "msys/git"
24+
unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
25+
coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
3326

3427
StaticTypeCheck:
3528
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@dev
3629
needs:
37-
- Params
30+
- UnitTestingParams
3831
with:
39-
python_version: ${{ needs.Params.outputs.python_version }}
32+
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
4033
commands: |
4134
mypy --html-report htmlmypy -p pySystemRDLModel
42-
html_artifact: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
35+
html_report: 'htmlmypy'
36+
html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
4337

44-
PublishTestResults:
45-
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
38+
DocCoverage:
39+
uses: pyTooling/Actions/.github/workflows/CheckDocumentation.yml@dev
4640
needs:
47-
- UnitTesting
41+
- UnitTestingParams
42+
with:
43+
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
44+
directory: pySystemRDLModel
45+
# fail_below: 70
46+
47+
ConfigParams:
48+
uses: pyTooling/Actions/.github/workflows/ExtractConfiguration.yml@dev
49+
needs:
50+
- DocCoverage
4851

4952
Package:
5053
uses: pyTooling/Actions/.github/workflows/Package.yml@dev
5154
needs:
52-
- Params
53-
- Coverage
55+
- UnitTestingParams
56+
- UnitTesting
5457
with:
55-
python_version: ${{ needs.Params.outputs.python_version }}
56-
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
58+
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
59+
artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
5760

58-
Release:
59-
uses: pyTooling/Actions/.github/workflows/Release.yml@dev
60-
if: startsWith(github.ref, 'refs/tags')
61+
PublishCoverageResults:
62+
uses: pyTooling/Actions/.github/workflows/PublishCoverageResults.yml@dev
6163
needs:
64+
- UnitTestingParams
6265
- UnitTesting
63-
- Coverage
64-
- StaticTypeCheck
65-
- Package
66+
with:
67+
# coverage_sqlite_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
68+
# coverage_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}
69+
coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
70+
coverage_html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
71+
secrets:
72+
codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
6673

67-
PublishOnPyPI:
68-
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@dev
69-
if: startsWith(github.ref, 'refs/tags')
74+
PublishTestResults:
75+
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
7076
needs:
71-
- Params
72-
- Release
73-
- Package
77+
- UnitTestingParams
78+
- UnitTesting
7479
with:
75-
python_version: ${{ needs.Params.outputs.python_version }}
76-
requirements: -r dist/requirements.txt
77-
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
78-
secrets:
79-
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
80+
merged_junit_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
8081

8182
# VerifyDocs:
8283
# uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@dev
8384
# needs:
84-
# - Params
85+
# - UnitTestingParams
8586
# with:
86-
# python_version: ${{ needs.Params.outputs.python_version }}
87+
# python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
8788

88-
BuildTheDocs:
89-
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@dev
89+
Documentation:
90+
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@dev
9091
needs:
91-
- Params
92+
- UnitTestingParams
93+
- ConfigParams
94+
- PublishTestResults
95+
- PublishCoverageResults
9296
# - VerifyDocs
9397
with:
94-
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
98+
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
99+
coverage_report_json_directory: ${{ needs.ConfigParams.outputs.coverage_report_json_directory }}
100+
unittest_xml_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-ubuntu-native-3.12
101+
coverage_json_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
102+
html_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
103+
latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
104+
105+
IntermediateCleanUp:
106+
uses: pyTooling/Actions/.github/workflows/IntermediateCleanUp.yml@dev
107+
needs:
108+
- UnitTestingParams
109+
- PublishCoverageResults
110+
- PublishTestResults
111+
- Documentation
112+
with:
113+
sqlite_coverage_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-
114+
xml_unittest_artifacts_prefix: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-
115+
116+
# PDFDocumentation:
117+
# uses: pyTooling/Actions/.github/workflows/LaTeXDocumentation.yml@dev
118+
# needs:
119+
# - UnitTestingParams
120+
# - Documentation
121+
# with:
122+
# document: pySystemRDLModel
123+
# latex_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
124+
# pdf_artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}
95125

96126
PublishToGitHubPages:
97127
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
98128
needs:
99-
- Params
100-
- BuildTheDocs
101-
- Coverage
129+
- UnitTestingParams
130+
- Documentation
131+
# - PDFDocumentation
132+
- PublishCoverageResults
102133
- StaticTypeCheck
103134
with:
104-
doc: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
105-
coverage: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
106-
typing: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
135+
doc: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
136+
# coverage: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
137+
typing: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
138+
139+
ReleasePage:
140+
uses: pyTooling/Actions/.github/workflows/Release.yml@dev
141+
if: startsWith(github.ref, 'refs/tags')
142+
needs:
143+
- Package
144+
- PublishToGitHubPages
145+
146+
PublishOnPyPI:
147+
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@dev
148+
if: startsWith(github.ref, 'refs/tags')
149+
needs:
150+
- UnitTestingParams
151+
- ReleasePage
152+
with:
153+
python_version: ${{ needs.UnitTestingParams.outputs.python_version }}
154+
requirements: -r dist/requirements.txt
155+
artifact: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
156+
secrets:
157+
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
107158

108159
ArtifactCleanUp:
109160
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@dev
110161
needs:
111-
- Params
162+
- UnitTestingParams
112163
- UnitTesting
113-
- Coverage
114164
- StaticTypeCheck
115-
- BuildTheDocs
116-
- PublishToGitHubPages
165+
- Documentation
166+
# - PDFDocumentation
117167
- PublishTestResults
168+
- PublishCoverageResults
169+
- PublishToGitHubPages
170+
# - PublishOnPyPI
118171
with:
119-
package: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
172+
package: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
120173
remaining: |
121-
${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}-*
122-
${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
123-
${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
124-
${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
174+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}-*
175+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_html }}-*
176+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}-*
177+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}-*
178+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}-*
179+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}-*
180+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_xml }}
181+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).unittesting_html }}
182+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_sqlite }}
183+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_xml }}
184+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_json }}
185+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).codecoverage_html }}
186+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).statictyping_html }}
187+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_html }}
188+
${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_latex }}
189+
# ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).documentation_pdf }}

.idea/pySystemRDLModel.iml

Lines changed: 3 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
wheel >= 0.40.0
2-
twine >= 4.0.2
1+
wheel ~= 0.44
2+
twine ~= 5.1

0 commit comments

Comments
 (0)