diff --git a/docs/source/coredev/index.rst b/docs/source/coredev/index.rst index fec87c0..9a35aae 100644 --- a/docs/source/coredev/index.rst +++ b/docs/source/coredev/index.rst @@ -9,7 +9,7 @@ developers of third party tools and libraries that use IPython should see the :doc:`../development/index`. -For instruction on how to make a developer install see :ref:`devinstall`. +For instructions on how to make a developer install see :ref:`devinstall`. .. toctree:: :maxdepth: 1 @@ -22,7 +22,27 @@ Backporting Pull requests All pull requests should usually be made against ``master``, if a Pull Request need to be backported to an earlier release; then it should be tagged with the -correct ``milestone``. We then use `ghpro ` +correct ``milestone``. + +If you are an admin on the IPython repository 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 + +The bot will attempt to backport the current pull-request and issue a PR if +possible. + +.. note:: + + The ``@`` and ``[dev]`` when mentioning the bot should be optional and can + be omitted. + + +Backport with ghpro +------------------- + +We can also use `ghpro ` to automatically list and apply the PR on other branches. For example: .. code-block:: bash diff --git a/docs/source/coredev/release_process.rst b/docs/source/coredev/release_process.rst index 3ad99e0..96ac52c 100644 --- a/docs/source/coredev/release_process.rst +++ b/docs/source/coredev/release_process.rst @@ -87,6 +87,9 @@ To find duplicates and update `.mailmap`, use:: git log --format="%aN <%aE>" $PREV_RELEASE... | sort -u -f +If a minor release you might need to do some of the above points manually, and +forward port the changes. + 3. Make sure the repository is clean ------------------------------------ @@ -243,8 +246,12 @@ The IPython website should document the new release: Make sure to update readthedocs and set the latest tag as stable, as well as checking that previous release is still building under its own tag. +13. Update the Conda-Forge feedstock +------------------------------------ + +Follow the instructions on `the repository `_ -13. Celebrate! +14. Celebrate! -------------- Celebrate the release and please thank the contributors for their work. Great