Skip to content

DOC: update release process maintainer guide #61810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −6
Open

DOC: update release process maintainer guide #61810

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions doc/source/development/maintaining.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,8 +388,11 @@ Pre-release

3. Make sure the CI is green for the last commit of the branch being released.

4. If not a release candidate, make sure all backporting pull requests to the branch
being released are merged.
4. If not a release candidate, make sure all backporting pull requests to the
branch being released are merged, and no merged pull requests are missing a
backport (check the
["Still Needs Manual Backport"](https://github.com/pandas-dev/pandas/labels/Still%20Needs%20Manual%20Backport)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noting this markdown style linking won't hyperlink as expected since this is rst.

label for this).

5. Create a new issue and milestone for the version after the one being released.
If the release was a release candidate, we would usually want to create issues and
Expand Down Expand Up @@ -435,6 +438,9 @@ which will be triggered when the tag is pushed.

scripts/download_wheels.sh <VERSION>

ATTENTION: this is currently not downloading *all* wheels, and you have to
manually download the remainings wheels and sdist!

4. Create a `new GitHub release <https://github.com/pandas-dev/pandas/releases/new>`_:

- Tag: ``<version>``
Expand Down Expand Up @@ -462,15 +468,22 @@ Post-Release
````````````

1. Update symlinks to stable documentation by logging in to our web server, and
editing ``/var/www/html/pandas-docs/stable`` to point to ``version/<latest-version>``
for major and minor releases, or ``version/<minor>`` to ``version/<patch>`` for
editing ``/var/www/html/pandas-docs/stable`` to point to ``version/<X.Y>``
for major and minor releases, or ``version/<X.Y>`` to ``version/<patch>`` for
patch releases. The exact instructions are (replace the example version numbers by
the appropriate ones for the version you are releasing):

- Log in to the server and use the correct user.
- ``cd /var/www/html/pandas-docs/``
- ``ln -sfn version/2.1 stable`` (for a major or minor release)
- ``ln -sfn version/2.0.3 version/2.0`` (for a patch release)
- For a major or minor release (assuming the ``/version/2.1.0/`` docs have been uploaded to the server):

- Create a new X.Y symlink to X.Y.Z: ``cd version; ln -sfn 2.1.0 2.1``
- Update stable symlink to point to X.Y: ``ln -sfn version/2.1 stable``

- For a patch release (assuming the ``/version/2.1.3/`` docs have been uploaded to the server):

- Update the X.Y symlink to the new X.Y.Z patch version: ``cd version; ln -sfn 2.1.3 2.1``
- (the stable symlink should already be pointing to the correct X.Y version)

2. If releasing a major or minor release, open a PR in our source code to update
``web/pandas/versions.json``, to have the desired versions in the documentation
Expand Down
Loading