From 05a6573b4ae8d80838e3ceb5d862ada07187ee7f 2018-09-07 12:31:28 From: Matthias Bussonnier Date: 2018-09-07 12:31:28 Subject: [PATCH] update release process --- diff --git a/docs/source/coredev/index.rst b/docs/source/coredev/index.rst index 5cb5b17..67e2c01 100644 --- a/docs/source/coredev/index.rst +++ b/docs/source/coredev/index.rst @@ -19,18 +19,17 @@ need to be backported to an earlier release; then it should be tagged with the correct ``milestone``. If you tag a pull request with a milestone **before** merging the pull request, -and the base ref is `master`, then our backport bot should automatically create +and the base ref is ``master``, then our backport bot should automatically create a corresponding pull-request that backport on the correct branch. -If you are an admin on the IPython repository you can also just mention the +If you have write access to the IPython repository you can also just mention the **backport bot** to do the work for you. The bot is evolving so instructions may be different. At the time of this writing you can use:: - @meeseeksdev[bot] backport [to ] + @meeseeksdev[bot] backport [to] The bot will attempt to backport the current pull-request and issue a PR if -possible. If the milestone is set on the issue you can omit the branch to -backport to. +possible. .. note:: @@ -149,8 +148,10 @@ If a major release: - Edit ``docs/source/whatsnew/index.rst`` to list the new ``github-stats-X`` file you just created. - - Remove temporarily the first entry called ``development`` (you'll need to - add it back after release). + - You do not need to temporarily remove the first entry called + ``development``, nor re-add it after the release, it will automatically be + hidden when releasing a stable version of IPython (if ``_version_extra`` + in ``release.py`` is an empty string. Make sure that the stats file has a header or it won't be rendered in the final documentation. diff --git a/docs/source/whatsnew/index.rst b/docs/source/whatsnew/index.rst index ef11789..6c638d8 100644 --- a/docs/source/whatsnew/index.rst +++ b/docs/source/whatsnew/index.rst @@ -12,6 +12,23 @@ What's new in IPython ===================== +.. this will appear in the docs if we are nto releasing a versin (ie is +.. _version_extra in release.py is empty stringA + +.. only:: ipydev + + Developpement version in-progress features: + + .. toctree:: + development + +.. this make a hidden toctree that avoid sphinx to complain about documents +.. included nowhere when building docs for stable +.. only:: ipystable + .. toctree:: + :hidden: + development + This section documents the changes that have been made in various versions of IPython. Users should consult these pages to learn about new features, bug fixes and backwards incompatibilities. Developers should summarize the @@ -20,7 +37,6 @@ development work they do here in a user friendly format. .. toctree:: :maxdepth: 1 - development version7 version6 github-stats-6 diff --git a/docs/source/whatsnew/version7.rst b/docs/source/whatsnew/version7.rst index b20cfab..f53e341 100644 --- a/docs/source/whatsnew/version7.rst +++ b/docs/source/whatsnew/version7.rst @@ -22,7 +22,7 @@ on the bugfix only 5.x branch, but we remind you that Python 2 EOL is Jan 1st We were able to backport bug fixes to the 5.x branch thanks to our backport bot which backported more than `70 Pull-Requests -`_, but there are still many PRs that required manually work, and this is an area of the project were you can easily contribute by looking for `PRs still needed backport`_ +`_, but there are still many PRs that required manually work, and this is an area of the project were you can easily contribute by looking for `PRs still needed backport `_ IPython 6.x branch will likely not see any further release unless we critical bugs are found. @@ -166,6 +166,7 @@ This new feature helps dual environment development - Jupyter+IDE - where the co first = MyClass(5) .. code:: + # mymodule/file1.py class MyClass: