Skip to content

Commit f9e81e0

Browse files
authored
Merge pull request #1849 from inclement/improve_release_process_doc
Improved release model documentation
2 parents e409aeb + 1b11691 commit f9e81e0

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

doc/source/contribute.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ and we'll deal with the rest.
1414
Development model
1515
-----------------
1616

17-
python-for-android is developed using the following model::
17+
python-for-android is developed using the following model:
1818

1919
- The ``master`` branch always represents the latest stable release.
2020
- The ``develop`` branch is the most up to date with new contributions.
@@ -44,20 +44,24 @@ Creating a new release
4444

4545
New releases follow these steps:
4646

47-
- Create a new branch ``release/YYYY.MM.DD`` based on the ``develop`` branch.
48-
- ``git checkout -b release/YYYY.MM.DD develop``
49-
- Create a Github pull request to merge ``release/YYYY.MM.DD`` into ``master``.
47+
- Create a new branch ``release-YYYY.MM.DD`` based on the ``develop`` branch.
48+
- ``git checkout -b release-YYYY.MM.DD develop``
49+
- Create a Github pull request to merge ``release-YYYY.MM.DD`` into ``master``.
5050
- Complete all steps in the `release checklist <release_checklist_>`_,
5151
and document this in the pull request (copy the checklist into the PR text)
5252

5353
At this point, wait for reviewer approval and conclude any discussion that arises. To complete the release:
5454

5555
- Merge the release branch to the ``master`` branch.
5656
- Also merge the release branch to the ``develop`` branch.
57-
- Tag the release commit in ``master``. Include a short summary of the changes.
58-
- Create the release distributions: ``python3 setup.py sdist``
57+
- Tag the release commit in ``master``, with tag ``vYYYY.MM.DD``. Include a short summary of the changes.
58+
- Create the release distributions: ``python3 setup.py sdist bdist_wheel``
5959
- Upload the release to pypi: ``python3 -m twine upload``.
60-
- Upload the release ``.tar.gz`` to the Github tag.
60+
- Add to the Github release page (see e.g. `this example <https://github.com/kivy/python-for-android/releases/tag/v2019.06.06>`__):
61+
- The python-for-android README summary
62+
- A short list of major changes in this release, if any
63+
- A changelog summarising merge commits since the last release
64+
- The release sdist and wheel(s)
6165

6266
.. _release_checklist:
6367

0 commit comments

Comments
 (0)