Skip to content

Commit cd5aa9f

Browse files
Added PlantUML diagram as documentation
1 parent 3626fa8 commit cd5aa9f

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,7 @@ This job will be triggered for releases AND prereleases in 'created' state (read
5454
## Test your work flow
5555
5656
In case you want to become acquainted with this work flow: The safest way to test the work flow is to create both Github secret entries ``TEST_PYPI_API_TOKEN`` and ``PROD_PYPI_API_TOKEN`` but assign an invalid token to them. When you run the workflow for a new 'master' branch prerelease, the job will try to push it to PyPi Test and will fail because of the invalid token.
57+
58+
## Workflow
59+
A basic workflow diagram of this Github Action can be found [here](docs/workflow.jpg)
60+

docs/workflow.jpg

140 KB
Loading

docs/workflow.plantuml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
@startuml
2+
!theme bluegray
3+
start
4+
if (Github Action\nPrecondition:\n\npublished\n(Pre-)Release for\nMaster branch) then (yes)
5+
package "get-python-version-info" {
6+
:Read\nPython\nFile;
7+
:Extract version\ninfo via Regular\nExpression;
8+
if (Did we find\nthe RegEx?) then (yes)
9+
if (Is this\nCommit\ntagged?) then (no)
10+
:Issue Github\nAction abort\ncommand;
11+
stop
12+
else (yes)
13+
if (Github release\nversion equals\nRegex release\nversion?) then (yes)
14+
:Supply RegEx\nversion\nas output;
15+
else (no)
16+
:Issue Github\nAction abort\ncommand;
17+
stop
18+
endif
19+
endif
20+
else (no)
21+
:Issue Github\nAction abort\ncommand;
22+
stop
23+
endif
24+
}
25+
package "deploy-to-pypi" {
26+
:Setup\nPython\nenvironment;
27+
:Installation\nPython\nDependencies;
28+
:Build\nPyPi-\nPacket;
29+
:Publish to\nPyPi Test;
30+
if (Prerelease?) then (yes)
31+
else (no)
32+
:Publish to\nPyPi Prod;
33+
endif
34+
35+
}
36+
endif
37+
stop
38+
@enduml

0 commit comments

Comments
 (0)