Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved release model documentation #1849

Merged
merged 1 commit into from
Jun 8, 2019
Merged

Improved release model documentation #1849

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions doc/source/contribute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ and we'll deal with the rest.
Development model
-----------------

python-for-android is developed using the following model::
python-for-android is developed using the following model:

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

New releases follow these steps:

- Create a new branch ``release/YYYY.MM.DD`` based on the ``develop`` branch.
- ``git checkout -b release/YYYY.MM.DD develop``
- Create a Github pull request to merge ``release/YYYY.MM.DD`` into ``master``.
- Create a new branch ``release-YYYY.MM.DD`` based on the ``develop`` branch.
- ``git checkout -b release-YYYY.MM.DD develop``
- Create a Github pull request to merge ``release-YYYY.MM.DD`` into ``master``.
AndreMiras marked this conversation as resolved.
Show resolved Hide resolved
- Complete all steps in the `release checklist <release_checklist_>`_,
and document this in the pull request (copy the checklist into the PR text)

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

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

.. _release_checklist:

Expand Down