Skip to content

Commit 8193c63

Browse files
authored
Merge pull request #17 from thc202/readme-release-steps
Update release steps in README file
2 parents e1c2153 + b2eb760 commit 8193c63

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,28 @@ To report issues related to OWASP ZAP API, bugs and enhancements requests, use t
2727

2828
### Release to PyPi
2929

30-
To build and upload to PyPi you can run the following:
30+
Example commands use the version `0.0.1`, it should be replaced accordingly to the version being released.
3131

32-
python setup.py sdist upload
32+
Tag (and push) the new version:
33+
34+
git tag -s 0.0.1 -m "Version 0.0.1."
35+
git push upstream 0.0.1
36+
37+
(Checkout the tag and ensure the working copy is clean.)
38+
39+
Build the distribution (source and wheel) files:
40+
41+
python setup.py sdist bdist_wheel --universal
42+
43+
Sign the distribution files:
44+
45+
gpg --detach-sign -a dist/python-owasp-zap-v2.4-0.0.1.tar.gz
46+
gpg --detach-sign -a dist/python_owasp_zap_v2.4-0.0.1-py2.py3-none-any.whl
47+
48+
Upload to PyPi:
49+
50+
twine upload \
51+
dist/python-owasp-zap-v2.4-0.0.1.tar.gz python-owasp-zap-v2.4-0.0.1.tar.gz.asc \
52+
dist/python_owasp_zap_v2.4-0.0.1-py2.py3-none-any.whl python_owasp_zap_v2.4-0.0.1-py2.py3-none-any.whl.asc
3353

3454
The user must have permissions to upload to the `python-owasp-zap-v2.4` package.

0 commit comments

Comments
 (0)