jiuyuan
/
test_ok1
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #893 from pfctdayelise/dupereleaseguides 

Delete duplicate release guide
This commit is contained in:
Bruno Oliveira 2015-07-26 20:59:07 -03:00
parent 017ceffb76 5ebad5c96d
commit 2035c5f8be
2 changed files with 55 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
HOWTORELEASE.rst
View File

@ -1,58 +1,87 @@
How to release pytest
How to release pytest (draft)
-------------------------------------------- --------------------------------------------
1. bump version numbers in _pytest/__init__.py (setup.py reads it) Note: this assumes you have already registered on pypi.
2. check and finalize CHANGELOG 1. Bump version numbers in _pytest/__init__.py (setup.py reads it)
3. write doc/en/announce/release-VERSION.txt and include 2. Check and finalize CHANGELOG
3. Write doc/en/announce/release-VERSION.txt and include
it in doc/en/announce/index.txt it in doc/en/announce/index.txt
4. use devpi for uploading a release tarball to a staging area: 4. Use devpi for uploading a release tarball to a staging area:
- ``devpi use https://devpi.net/USER/dev``
- ``devpi upload --formats sdist,bdist_wheel``
5. run from multiple machines: ``devpi use https://devpi.net/USER/dev``
- ``devpi use https://devpi.net/USER/dev`` ``devpi upload --formats sdist,bdist_wheel``
- ``devpi test pytest==VERSION``
5. Run from multiple machines:
``devpi use https://devpi.net/USER/dev``
``devpi test pytest==VERSION``
6. Check that tests pass for relevant combinations with
``devpi list pytest``
6. check that tests pass for relevant combinations with
``devpi list pytest``
or look at failures with "devpi list -f pytest". or look at failures with "devpi list -f pytest".
There will be some failed environments like e.g. the py33-trial There will be some failed environments like e.g. the py33-trial
or py27-pexpect tox environments on Win32 platforms or py27-pexpect tox environments on Win32 platforms
which is ok (tox does not support skipping on which is ok (tox does not support skipping on
per-platform basis yet). per-platform basis yet).
7. Regenerate the docs examples using tox:: 7. Regenerate the docs examples using tox, and check for regressions::
# Create and activate a virtualenv with regendoc installed
# (currently needs revision 4a9ec1035734)
tox -e regen tox -e regen
git diff
8. Build the docs, you need a virtualenv with, py and sphinx 8. Build the docs, you need a virtualenv with, py and sphinx
installed:: installed::
cd docs/en cd docs/en
make html make html
Commit any changes before tagging the release.
9. Tag the release:: 9. Tag the release::
hg tag VERSION
git tag VERSION
git push
10. Upload the docs using docs/en/Makefile:: 10. Upload the docs using docs/en/Makefile::
cd docs/en cd docs/en
make install # or "installall" if you have LaTeX installed make install # or "installall" if you have LaTeX installed for PDF
This requires ssh-login permission on pytest.org because it uses This requires ssh-login permission on pytest.org because it uses
rsync. rsync.
Note that the "install" target of doc/en/Makefile defines where the Note that the "install" target of doc/en/Makefile defines where the
rsync goes to, typically to the "latest" section of pytest.org. rsync goes to, typically to the "latest" section of pytest.org.
11. publish to pypi "devpi push pytest-VERSION pypi:NAME" where NAME If you are making a minor release (e.g. 5.4), you also need to manually
is the name of pypi.python.org as configured in your create a symlink for "latest"::
~/.pypirc file -- it's the same you would use with
"setup.py upload -r NAME"
12. send release announcement to mailing lists: ssh pytest-dev@pytest.org
ln -s 5.4 latest
pytest-dev Browse to pytest.org to verify.
testing-in-python
python-announce-list@python.org 11. Publish to pypi::
devpi push pytest-VERSION pypi:NAME
where 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>`_.
12. Send release announcement to mailing lists:
- pytest-dev
- testing-in-python
- python-announce-list@python.org
13. **after the release** Bump the version number in ``_pytest/__init__.py``,
to the next Minor release version (i.e. if you released ``pytest-2.8.0``,
set it to ``pytest-2.9.0.dev1``).

54
doc/en/release.txt
View File

@ -1,54 +0,0 @@
pytest release checklist
-------------------------
For doing a release of pytest (status April 2015) this rough checklist is used:
1. change version numbers in ``_pytest/__init__.py`` to the to-be-released version.
(the version number in ``setup.py`` reads from that init file as well)
2. finalize ``./CHANGELOG`` (don't forget the the header).
3. write ``doc/en/announce/release-VERSION.txt``
(usually copying from an earlier release version).
4. regenerate doc examples with ``tox -e regen`` and check with ``git diff``
if the differences show regressions. It's a bit of a manual process because
there a large part of the diff is about pytest headers or differences in
speed ("tests took X.Y seconds"). (XXX automate doc/example diffing to ignore
such changes and integrate it into "tox -e regen").
5. ``devpi upload`` to `your developer devpi index <http://doc.devpi.net/latest/quickstart-releaseprocess.html>`_. You can create your own user and index on https://devpi.net,
an inofficial service from the devpi authors.
6. run ``devpi use INDEX`` and ``devpi test`` from linux and windows machines
and verify test results on the index. On linux typically all environments
pass (April 2015 there is a setup problem with a cx_freeze environment)
but on windows all involving ``pexpect`` fail because pexpect does not exist
on windows and tox does not allow to have platform-specific environments.
Also on windows ``py33-trial`` fails but should probably pass (March 2015).
In any case, py26,py27,py33,py34 are required to pass for all platforms.
7. You can fix tests/code and repeat number 6. until everything passes.
8. Once you have sufficiently passing tox tests you can do the actual release::
cd doc/en/
make install # will install to 2.7, 2.8, ... according to _pytest/__init__.py
make install-pdf # optional, requires latex packages installed
ssh pytest-dev@pytest.org # MANUAL: symlink "pytest.org/latest" to the just
# installed release docs
# browse to pytest.org to see
devpi push pytest-VERSION pypi:NAME
git commit -a -m "... finalized pytest-VERSION"
git tag VERSION
git push
9. send out release announcement to pytest-dev@python.org,
testing-in-python@lists.idyll.org and python-announce-list@python.org .
10. **after the release** bump the version number in ``_pytest/__init__.py``,
to the next Minor release version (i.e. if you released ``pytest-2.8.0``,
set it to ``pytest-2.9.0.dev1``).
11. already done :)