Skip to content

Commit 2d60af8

Browse files
committed
📝 docs: add step-by-step to publish a new version
1 parent 7e4419d commit 2d60af8

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.rst

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Make sure you are reading the correct documentation:
2323

2424
develop branch: https://github.com/vintasoftware/django-templated-email/blob/develop/README.rst
2525

26-
stable pypi/master: https://github.com/vintasoftware/django-templated-email/blob/master/README.rst
26+
stable pypi/main: https://github.com/vintasoftware/django-templated-email/blob/main/README.rst
2727

2828

2929
Requirements
@@ -436,14 +436,33 @@ For installation and usage, see the `django-templated-email-md <https://github.c
436436
Releasing a new version of this package:
437437
========================================
438438

439-
Update CHANGELOG file.
439+
- Create a new branch off develop, named like *feat/update-to-x.y.z* where x.y.z is the new version number.
440440

441-
Execute the following commands::
441+
- Update CHANGELOG file.
442+
443+
- Update the version executing::
442444

443445
bumpversion [major,minor,patch]
444-
python setup.py publish
446+
447+
- Open a pull request to merge your branch into main, and get it reviewed.
448+
449+
- Once the pull request is approved and merged, checkout main branch and pull the latest changes.
450+
451+
- Push the tag generated by bumpversion to the remote repository::
452+
445453
git push origin --tags
446454

455+
- Create a new release on GitHub, using the tag created by bumpversion. Make sure to use the same version number as the one you set with bumpversion.
456+
457+
- Finally, publish the new version to PyPI executing::
458+
459+
python setup.py publish
460+
461+
- Update develop branch with the changes from main, and push it to the remote repository::
462+
463+
git checkout develop
464+
git pull origin main
465+
git push origin develop
447466

448467
Commercial Support
449468
==================

0 commit comments

Comments
 (0)