Skip to content

Updated release instructions to use rst instead of markdown #50886

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

Merged
merged 3 commits into from
Jan 23, 2023
Merged

Updated release instructions to use rst instead of markdown #50886

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
94bb3f8
rst formatted release instructions
tpackard1 Jan 20, 2023
ecd3212
updated release instructions line 456
tpackard1 Jan 20, 2023
0f5726c
avoid duplicate explicit target name
tpackard1 Jan 20, 2023
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
30 changes: 15 additions & 15 deletions doc/source/development/maintaining.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,10 +349,10 @@ The release process makes a snapshot of pandas (a git commit) available to users
a particular version number. After the release the new pandas version will be available
in the next places:

- Git repo with a [new tag](https://github.com/pandas-dev/pandas/tags)
- Source distribution in a [GitHub release](https://github.com/pandas-dev/pandas/releases)
- Pip packages in the [PyPI](https://pypi.org/project/pandas/)
- Conda/Mamba packages in [conda-forge](https://anaconda.org/conda-forge/pandas)
- Git repo with a `new tag <https://github.com/pandas-dev/pandas/tags>`_
- Source distribution in a `GitHub release <https://github.com/pandas-dev/pandas/releases>`_
- Pip packages in the `PyPI <https://pypi.org/project/pandas/>`_
- Conda/Mamba packages in `conda-forge <https://anaconda.org/conda-forge/pandas>`_

The process for releasing a new version of pandas is detailed next section.

Expand All @@ -368,11 +368,11 @@ Prerequisites

In order to be able to release a new pandas version, the next permissions are needed:

- Merge rights to the [pandas](https://github.com/pandas-dev/pandas/),
[pandas-wheels](https://github.com/MacPython/pandas-wheels), and
[pandas-feedstock](https://github.com/conda-forge/pandas-feedstock/) repositories.
- Merge rights to the `pandas <https://github.com/pandas-dev/pandas/>`_,
`pandas-wheels <https://github.com/MacPython/pandas-wheels>`_, and
`pandas-feedstock <https://github.com/conda-forge/pandas-feedstock/>`_ repositories.
- Permissions to push to main in the pandas repository, to push the new tags.
- Write permissions to [PyPI](https://github.com/conda-forge/pandas-feedstock/pulls)
- Write permissions to `PyPI <https://github.com/conda-forge/pandas-feedstock/pulls>`_
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Write permissions to `PyPI <https://github.com/conda-forge/pandas-feedstock/pulls>`_
- `Write permissions to PyPI <https://github.com/conda-forge/pandas-feedstock/pulls>`_

To avoid

2023-01-20T05:53:13.6374953Z /home/runner/work/pandas/pandas/doc/source/development/maintaining.rst:5: WARNING: Duplicate explicit target name: "pypi".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @mroeschke! I will make the change rn

- Access to the social media accounts, to publish the announcements.

Pre-release
Expand Down Expand Up @@ -408,7 +408,7 @@ Pre-release
Release
```````

1. Create an empty commit and a tag in the last commit of the branch to be released:
1. Create an empty commit and a tag in the last commit of the branch to be released::

git checkout <branch>
git pull --ff-only upstream <branch>
Expand All @@ -423,7 +423,7 @@ which will be triggered when the tag is pushed.
2. Only if the release is a release candidate, we want to create a new branch for it, immediately
after creating the tag. For example, if we are releasing pandas 1.4.0rc0, we would like to
create the branch 1.4.x to backport commits to the 1.4 versions. As well as create a tag to
mark the start of the development of 1.5.0 (assuming it is the next version):
mark the start of the development of 1.5.0 (assuming it is the next version)::

git checkout -b 1.4.x
git push upstream 1.4.x
Expand All @@ -436,7 +436,7 @@ which will be triggered when the tag is pushed.

./setup.py sdist --formats=gztar --quiet

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

- Title: ``Pandas <version>``
- Tag: ``<version>``
Expand All @@ -447,13 +447,13 @@ which will be triggered when the tag is pushed.
(e.g. releasing 1.4.5 after 1.5 has been released)

5. The GitHub release will after some hours trigger an
[automated conda-forge PR](https://github.com/conda-forge/pandas-feedstock/pulls).
`automated conda-forge PR <https://github.com/conda-forge/pandas-feedstock/pulls>`_.
Merge it once the CI is green, and it will generate the conda-forge packages.

6. Packages for supported versions in PyPI are built in the
[MacPython repo](https://github.com/MacPython/pandas-wheels).
`MacPython repo <https://github.com/MacPython/pandas-wheels>`_.
Open a PR updating the build commit to the released version, and merge it once the
CI is green.
CI is green. To do this type::

git checkout master
git pull --ff-only upstream master
Expand Down Expand Up @@ -486,7 +486,7 @@ Post-Release
4. Create a new issue for the next release, with the estimated date of release.

5. Open a PR with the placeholder for the release notes of the next version. See
for example [the PR for 1.5.3](https://github.com/pandas-dev/pandas/pull/49843/files).
for example `the PR for 1.5.3 <https://github.com/pandas-dev/pandas/pull/49843/files>`_.

6. Announce the new release in the official channels (use previous announcements
for reference):
Expand Down