test_ok2/HOWTORELEASE.rst

Release Procedure
-----------------

Our current policy for releasing is to aim for a bugfix every few weeks and a minor release every 2-3 months. The idea
is to get fixes and new features out instead of trying to cram a ton of features into a release and by consequence
taking a lot of time to make a new one.

.. important::

    pytest releases must be prepared on **Linux** because the docs and examples expect
    to be executed in that platform.

#. Create a branch ``release-X.Y.Z`` with the version for the release.

   * **maintenance releases**: from ``4.6-maintenance``;

   * **patch releases**: from the latest ``master``;

   * **minor releases**: from the latest ``features``; then merge with the latest ``master``;

   Ensure your are in a clean work tree.

#. Using ``tox``, generate docs, changelog, announcements::

    $ tox -e release -- <VERSION>

   This will generate a commit with all the changes ready for pushing.

#. Open a PR for this branch targeting ``master`` (or ``4.6-maintenance`` for
   maintenance releases).

#. After all tests pass and the PR has been approved, publish to PyPI by pushing the tag::

     git tag <VERSION>
     git push git@github.com:pytest-dev/pytest.git <VERSION>

   Wait for the deploy to complete, then make sure it is `available on PyPI <https://pypi.org/project/pytest>`_.

#. Merge the PR.

#. If this is a maintenance release, cherry-pick the CHANGELOG / announce
   files to the ``master`` branch::

       git fetch --all --prune
       git checkout origin/master -b cherry-pick-maintenance-release
       git cherry-pick --no-commit -m1 origin/4.6-maintenance
       git checkout origin/master -- changelog
       git commit  # no arguments

#. Send an email announcement with the contents from::

     doc/en/announce/release-<VERSION>.rst

   To the following mailing lists:

   * pytest-dev@python.org (all releases)
   * python-announce-list@python.org (all releases)
   * testing-in-python@lists.idyll.org (only major/minor releases)

   And announce it on `Twitter <https://twitter.com/>`_ with the ``#pytest`` hashtag.
Add development guide to docs 2017-09-08 04:48:34 +08:00			`Release Procedure`
			`-----------------`

			`Our current policy for releasing is to aim for a bugfix every few weeks and a minor release every 2-3 months. The idea`
			`is to get fixes and new features out instead of trying to cram a ton of features into a release and by consequence`
			`taking a lot of time to make a new one.`
prepare 2.6.2, release announcement, also add HOWTORELEASE.rst 2014-09-05 19:13:23 +08:00
Implement tasks to improve release automation 2017-05-16 07:23:04 +08:00			`.. important::`
Delete release.txt from docs, merge extra comments to HOWTORELEASE.rst 2015-07-26 21:20:32 +08:00
Update HOWTORELEASE * Remove the CHANGELOG step now that it is automated; * Overall clean-up and formatting, trying to make the steps more explicit; 2017-05-31 08:26:41 +08:00			`pytest releases must be prepared on Linux because the docs and examples expect`
Implement tasks to improve release automation 2017-05-16 07:23:04 +08:00			`to be executed in that platform.`
update release process to ensure correct usage of base branches and propper finalization 2016-02-14 03:29:30 +08:00
Update HOWTORELEASE * Remove the CHANGELOG step now that it is automated; * Overall clean-up and formatting, trying to make the steps more explicit; 2017-05-31 08:26:41 +08:00			#. Create a branch ``release-X.Y.Z`` with the version for the release.
update authors list for 2.8.3 and add a log command to the howto 2015-11-19 00:55:18 +08:00
Update release instructions for 4.6-maintenance 2019-06-03 01:06:41 +08:00			* maintenance releases: from ``4.6-maintenance``;

Update HOWTORELEASE * Remove the CHANGELOG step now that it is automated; * Overall clean-up and formatting, trying to make the steps more explicit; 2017-05-31 08:26:41 +08:00			* patch releases: from the latest ``master``;
prepare 2.6.2, release announcement, also add HOWTORELEASE.rst 2014-09-05 19:13:23 +08:00
Update HOWTORELEASE * Remove the CHANGELOG step now that it is automated; * Overall clean-up and formatting, trying to make the steps more explicit; 2017-05-31 08:26:41 +08:00			* minor releases: from the latest ``features``; then merge with the latest ``master``;

			`Ensure your are in a clean work tree.`

Revamp the release script: drop invoke and use tox directly Following the lead from tox, use a simple Python script instead of depending on ``invoke``. Other changes: * Some colors using ``colorama``. * Run ``pre-commit`` before the final commit to ensure everything is neatly formatted. * Drop generating local tag: legacy from the time we used ``devpi`` as staging area, currently we no longer use it, and we should push a tag from the last HEAD of the PR always to ensure it is correct. 2018-07-14 21:21:31 +08:00			#. Using ``tox``, generate docs, changelog, announcements::
HOWTORELEASE: create branch first and run pre-commit after generate-release task This makes more sense because we need to install from tasks/requirements.txt 2018-07-04 09:15:11 +08:00
Revamp the release script: drop invoke and use tox directly Following the lead from tox, use a simple Python script instead of depending on ``invoke``. Other changes: * Some colors using ``colorama``. * Run ``pre-commit`` before the final commit to ensure everything is neatly formatted. * Drop generating local tag: legacy from the time we used ``devpi`` as staging area, currently we no longer use it, and we should push a tag from the last HEAD of the PR always to ensure it is correct. 2018-07-14 21:21:31 +08:00			`$ tox -e release -- <VERSION>`
Update HOWTORELEASE based on the 3.0.0 release 2016-08-20 05:50:46 +08:00
Revamp the release script: drop invoke and use tox directly Following the lead from tox, use a simple Python script instead of depending on ``invoke``. Other changes: * Some colors using ``colorama``. * Run ``pre-commit`` before the final commit to ensure everything is neatly formatted. * Drop generating local tag: legacy from the time we used ``devpi`` as staging area, currently we no longer use it, and we should push a tag from the last HEAD of the PR always to ensure it is correct. 2018-07-14 21:21:31 +08:00			`This will generate a commit with all the changes ready for pushing.`
Update HOWTORELEASE * Remove the CHANGELOG step now that it is automated; * Overall clean-up and formatting, trying to make the steps more explicit; 2017-05-31 08:26:41 +08:00
Update release instructions for 4.6-maintenance 2019-06-03 01:06:41 +08:00			#. Open a PR for this branch targeting ``master`` (or ``4.6-maintenance`` for
			`maintenance releases).`
Update HOWTORELEASE * Remove the CHANGELOG step now that it is automated; * Overall clean-up and formatting, trying to make the steps more explicit; 2017-05-31 08:26:41 +08:00
Implement publishing to PyPI by pushing a tag Fix #3060 2018-02-10 06:59:15 +08:00			`#. After all tests pass and the PR has been approved, publish to PyPI by pushing the tag::`
Delete release.txt from docs, merge extra comments to HOWTORELEASE.rst 2015-07-26 21:20:32 +08:00
Update release procedure [ci skip] 2018-08-30 05:13:08 +08:00			`git tag <VERSION>`
Implement publishing to PyPI by pushing a tag Fix #3060 2018-02-10 06:59:15 +08:00			`git push git@github.com:pytest-dev/pytest.git <VERSION>`
Update HOWTORELEASE based on the 3.0.0 release 2016-08-20 05:50:46 +08:00
Implement publishing to PyPI by pushing a tag Fix #3060 2018-02-10 06:59:15 +08:00			Wait for the deploy to complete, then make sure it is `available on PyPI <https://pypi.org/project/pytest>`_.
prepare 2.6.2, release announcement, also add HOWTORELEASE.rst 2014-09-05 19:13:23 +08:00
Update release instructions for 4.6-maintenance 2019-06-03 01:06:41 +08:00			`#. Merge the PR.`

			`#. If this is a maintenance release, cherry-pick the CHANGELOG / announce`
			files to the ``master`` branch::

			`git fetch --all --prune`
			`git checkout origin/master -b cherry-pick-maintenance-release`
			`git cherry-pick --no-commit -m1 origin/4.6-maintenance`
			`git checkout origin/master -- changelog`
			`git commit # no arguments`
Update release procedure [ci skip] 2018-08-30 05:13:08 +08:00
Implement publishing to PyPI by pushing a tag Fix #3060 2018-02-10 06:59:15 +08:00			`#. Send an email announcement with the contents from::`
prepare 2.6.2, release announcement, also add HOWTORELEASE.rst 2014-09-05 19:13:23 +08:00
Implement publishing to PyPI by pushing a tag Fix #3060 2018-02-10 06:59:15 +08:00			`doc/en/announce/release-<VERSION>.rst`
prepare 2.6.2, release announcement, also add HOWTORELEASE.rst 2014-09-05 19:13:23 +08:00
Implement publishing to PyPI by pushing a tag Fix #3060 2018-02-10 06:59:15 +08:00			`To the following mailing lists:`
Update HOWTORELEASE * Remove the CHANGELOG step now that it is automated; * Overall clean-up and formatting, trying to make the steps more explicit; 2017-05-31 08:26:41 +08:00
Implement publishing to PyPI by pushing a tag Fix #3060 2018-02-10 06:59:15 +08:00			`* pytest-dev@python.org (all releases)`
			`* python-announce-list@python.org (all releases)`
			`* testing-in-python@lists.idyll.org (only major/minor releases)`
Delete release.txt from docs, merge extra comments to HOWTORELEASE.rst 2015-07-26 21:20:32 +08:00
Implement publishing to PyPI by pushing a tag Fix #3060 2018-02-10 06:59:15 +08:00			And announce it on `Twitter <https://twitter.com/>`_ with the ``#pytest`` hashtag.