Skip to content

Commit 76561d1

Browse files
authored
Updated release instructions to use rst instead of markdown (#50886)
* rst formatted release instructions * updated release instructions line 456 * avoid duplicate explicit target name
1 parent 1128f5e commit 76561d1

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

doc/source/development/maintaining.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -349,10 +349,10 @@ The release process makes a snapshot of pandas (a git commit) available to users
349349
a particular version number. After the release the new pandas version will be available
350350
in the next places:
351351

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

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

@@ -368,11 +368,11 @@ Prerequisites
368368

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

371-
- Merge rights to the [pandas](https://github.com/pandas-dev/pandas/),
372-
[pandas-wheels](https://github.com/MacPython/pandas-wheels), and
373-
[pandas-feedstock](https://github.com/conda-forge/pandas-feedstock/) repositories.
371+
- Merge rights to the `pandas <https://github.com/pandas-dev/pandas/>`_,
372+
`pandas-wheels <https://github.com/MacPython/pandas-wheels>`_, and
373+
`pandas-feedstock <https://github.com/conda-forge/pandas-feedstock/>`_ repositories.
374374
- Permissions to push to main in the pandas repository, to push the new tags.
375-
- Write permissions to [PyPI](https://github.com/conda-forge/pandas-feedstock/pulls)
375+
- `Write permissions to PyPI <https://github.com/conda-forge/pandas-feedstock/pulls>`_
376376
- Access to the social media accounts, to publish the announcements.
377377

378378
Pre-release
@@ -408,7 +408,7 @@ Pre-release
408408
Release
409409
```````
410410

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

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

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

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

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

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

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

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

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

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

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

0 commit comments

Comments
 (0)