Skip to content

Commit ee32154

Browse files
Update README.md
1 parent c58b05b commit ee32154

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This is a __Github Actions__ workflow for automatic publications to PyPi. Version data from a python file is extracted and then used by the PyPi setup process which will publish the package to PyPi Test and Prod.
44

5-
The workflow will only be triggered for the publication of new repo releases.
5+
The workflow will only be triggered for the publication of new repo releases / prereleases for the 'master' repo branch.
66

77
## Installation instructions
88

@@ -42,12 +42,12 @@ Replace the placeholder for the source file with the relative path to your Pytho
4242
4343
## Running the Github Action
4444
45-
This Github action will do the following __whenever a new release is published__:
45+
This Github action will do the following __whenever a new release/pre-release is published for the 'master' branch__:
4646
4747
- Read the Python file and extract the version information, based on the given Regex. Abort job if no match was found.
4848
- Check if the Github ``ref_type`` has the value ``tag``. This is only the case when you drafted a new release. Otherwise, this value is likely set to ``master``. Abort job in case of a mismatch.
49-
- Check if the Github ``ref_name`` is equal to the extracted version from you Python file. Abort job in case of a mismatch.
50-
- Build the PyPi package. Deploy it to PyPi Test and (if successful) PyPi Prod.
49+
- Check if the Github ``ref_name`` is equal to the extracted version from you Python file. Abort job in case of a mismatch. This will prevent issues where there is a mismatch between your Github release version (tag) and the one in the Python file.
50+
- Build the PyPi package. Deploy it to PyPi Test and (if successful AND not a pre-release) PyPi Prod.
5151
5252
This job will be triggered for releases AND prereleases in 'created' state (read: you tag a (pre)release in Github). Releases will be pushed to both PyPi Test and Prod whereas prereleases will only be pushed to PyPi Test.
5353

0 commit comments

Comments
 (0)