33> Don't forger to change version before deployment!
44> Deployment ** MUST** be done from the ` main ` branch only!
55
6- ### 1. Create tag in Github repository
7- Create tag on current commit named ` v{CURRENT_VERSION} `
8-
9- ### 2. Create deployment in Github
10- Use previously created tag for it.
11-
12- ### 1. Deploy to pypi
13- In root repository directory:
14- ```
15- rm -r ./dist
16- python -m build
17- python -m twine check dist/*
18- python -m twine upload dist/*
19- ```
20- > For the last command use ` __token__ ` as username and your token value as password when prompted.
21-
22- ### 2. Update documentation on Github Pages
6+ ### 1. Update documentation on Github Pages
237> Make sure you installed docs dependencies in ** SEPARATE** virtual env and activated it
248
259In ` docs ` directory call call:
3216build.py 2.18.0.0
3317```
3418
35- ### 3 . Update badges
19+ ### 2 . Update badges
3620
3721In repo root directory:
3822
@@ -59,4 +43,20 @@ genbadge tests -i ./docs/reports/junit/junit.xml -o ./docs/badges/test-badge.svg
5943``` bash
6044flake8 ./rulekit --exit-zero --format=html --htmldir ./docs/reports/flake8 --statistics --tee --output-file ./docs/reports/flake8/flake8stats.txt
6145genbadge flake8 -i ./docs/reports/flake8/flake8stats.txt -o ./docs/badges/flake8-badge.svg
62- ```
46+ ```
47+
48+ ### 3. Create tag in Github repository
49+ Create tag on current commit named ` v{CURRENT_VERSION} `
50+
51+ ### 4. Create deployment in Github
52+ Use previously created tag for it.
53+
54+ ### 5. Deploy to pypi
55+ In root repository directory:
56+ ```
57+ rm -r ./dist
58+ python -m build
59+ python -m twine check dist/*
60+ python -m twine upload dist/*
61+ ```
62+ > For the last command use ` __token__ ` as username and your token value as password when prompted.
0 commit comments