p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update HOWTORELEASE 

* Remove the CHANGELOG step now that it is automated;
* Overall clean-up and formatting, trying to make the steps more
  explicit;
This commit is contained in:
Bruno Oliveira 2017-05-30 21:26:41 -03:00
parent 1dee443c2b
commit 281fcd5a58
1 changed files with 29 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
HOWTORELEASE.rst
View File

@ -3,47 +3,59 @@ How to release pytest
.. important:: .. important::
pytest releases must be prepared on **linux** because the docs and examples expect pytest releases must be prepared on **Linux** because the docs and examples expect
to be executed in that platform. to be executed in that platform.
#. Install development dependencies in a virtual environment with:: #. Install development dependencies in a virtual environment with::
pip3 install -r tasks/requirements.txt pip3 install -r tasks/requirements.txt
#. Create a branch ``release-X.Y.Z`` with the version for the release. Make sure it is up to date #. Create a branch ``release-X.Y.Z`` with the version for the release.
with the latest ``master`` (for patch releases) and with the latest ``features`` merged with
the latest ``master`` (for minor releases). Ensure your are in a clean work tree.
#. Check and finalize ``CHANGELOG.rst`` (will be automated soon). * **patch releases**: from the latest ``master``;
#. Execute to automatically generate docs, announcements and upload a package to * **minor releases**: from the latest ``features``; then merge with the latest ``master``;
Ensure your are in a clean work tree.
#. Generate docs, changelog, announcements and upload a package to
your ``devpi`` staging server:: your ``devpi`` staging server::
invoke generate.pre_release <VERSION> <DEVPI USER> --password <DEVPI PASSWORD> invoke generate.pre_release <VERSION> <DEVPI USER> --password <DEVPI PASSWORD>
If ``--password`` is not given, it is assumed the user is already logged in. If you don't have If ``--password`` is not given, it is assumed the user is already logged in ``devpi``.
an account, please ask for one! If you don't have an account, please ask for one.
#. Run from multiple machines:: #. Open a PR for this branch targeting ``master``.
devpi use https://devpi.net/USER/dev #. Test the package
devpi test pytest==VERSION
Alternatively, you can use `devpi-cloud-tester <https://github.com/nicoddemus/devpi-cloud-tester>`_ to test * **Manual method**
the package on AppVeyor and Travis (follow instructions on the ``README``).
#. Check that tests pass for relevant combinations with:: Run from multiple machines::
devpi use https://devpi.net/USER/dev
devpi test pytest==VERSION
Check that tests pass for relevant combinations with::
devpi list pytest devpi list pytest
or look at failures with "devpi list -f pytest". * **CI servers**
#. Feeling confident? Publish to PyPI:: Configure a repository as per-instructions on
devpi-cloud-test_ to test the package on Travis_ and AppVeyor_.
All test environments should pass.
#. Publish to PyPI::
invoke generate.publish_release <VERSION> <DEVPI USER> <PYPI_NAME> invoke generate.publish_release <VERSION> <DEVPI USER> <PYPI_NAME>
where PYPI_NAME is the name of pypi.python.org as configured in your ``~/.pypirc`` where PYPI_NAME is the name of pypi.python.org as configured in your ``~/.pypirc``
file `for devpi <http://doc.devpi.net/latest/quickstart-releaseprocess.html?highlight=pypirc#devpi-push-releasing-to-an-external-index>`_. file `for devpi <http://doc.devpi.net/latest/quickstart-releaseprocess.html?highlight=pypirc#devpi-push-releasing-to-an-external-index>`_.
#. After a minor/major release, merge ``features`` into ``master`` and push (or open a PR). #. After a minor/major release, merge ``features`` into ``master`` and push (or open a PR).
.. _devpi-cloud-test: https://github.com/obestwalter/devpi-cloud-test
.. _AppVeyor: https://www.appveyor.com/
.. _Travis: https://travis-ci.org