RLS: 0.22.0

[TomAugspurger]

Tracking issue for 0.22.0, which is a special release with just the all-NA / empty sum / prod changes.

All the changes are in master and just need to be backported.

When do we want to do the release? Some people may be out for the holidays, but I believe the preference was to have 0.22.0 out as soon as possible, so perhaps today or tomorrow?

cc @pandas-dev/pandas-core

---

Pre-Release

• Open a pre-release issue and mention related parties. (A few weeks before release) with this template.
• Clear the bug queue
• Run an ASV: `cd asv_bench; asv continuous -f 1.1 $(git describe --abbrev=0)..HEAD``
• Review deprecations from previous releases here
• Review experimental features from previous releases here
• Clean up release.rst (contributors and stats will be done later)
• Clean up whatsnew.rst
• Run a full doc build and make sure everything is clean

  ./make.py clean; ./make.py; ./make.py zip_html;  ./make.py latex_forced
  

  • Check the output, check whatsnew and release.rst for formatting errors.
• run build_dist.sh, uninstall cython and make a test install of the tarball to ensure
  cython is not required for installation from tarball/pypi (now also part of travis scripts, but check).
• Ensure you have SSH access to pandas.pydata.org (@TomAugspurger or Andy Terrel should be able to get you an account).
• Ensure you have upload rights to PyPI (Wes or Jeff)
• Ensure you have commit rights on github.com/macPython/pandas-wheels/ and github.com/conda-forge/pandas-feedstock

The Release

Final Pre-Release

To be done just before tagging the commit. This is optional for release-candidates.

• Call a hold on master in the pre-release issue before you start.
• Finalize the documentation by running the
  • Run scripts/announce.py and add to release.rst
  • Update the release date in release.rst and whatsnew/<version>.rst
• Commit the doc changes

Tag the Release

• Create an empty commit: git commit --allow-empty -m 'RLS: v0.20.0'
  • For Release-Candidates, it's -m 'RLS: v0.20.0.rc2'
• Create the tag: git tag -a v0.20.0 -m "Version 0.20.0"

Test the Release

Some local sanity tests before pushing, making the release official

• Build the release
  • Conda:

# build a conda package
conda build ./conda.recipe --numpy 1.11 --python 2.7 -q --output

# fresh conda env
conda create -n pandas_0.18.2_test python=2.7 pandas nose

# build and install into that env
conda install -n pandas_0.18.2_test pandas --use-local

# switch to that env & test
source activate pandas_0.18.2_test
import pandas as pd
pd.test()

• Pip

# build the wheel
python setup.py bdist_wheel

# activate another environment
workon pandas-test
pip uninstall -y pandas
pip install <path/to/wheel>
python -c "import pandas; pandas.test()"

• Build the docs. Check the version number and release notes

Push the Release

This is where things become final. No going back once the tagged commit is pushed

• Push the release
  • Major release: git push upstream master --follow-tags
  • Maintenance: git push upstream 0.20.x --follow-tags

Build Source Distribution

• python setup.py sdist --formats=gztar (TODO: update build_dist.sh to handle maintenance branches)

Release on Github

• Draft a new release here
• If this is an RC, check the box saying it's a pre-release
• Upload the pandas-<version>.tar.gz from the previous step as a "binary"
• Generate the SHA256 for the release with openssl dgst -sha256 dist/pandas-<version>.tar.gz
  We use the SHA from our .tar.gz since the one auto-generated by Github isn't stable if the release page
  is later modified.

Build Binary Distributions

Windows wheels are built automatically by Christoph Gohlke.

• Open a PR for Mac and Linux wheels to update the BUILD_COMMIT here
• Final Release Only Open a PR for the pandas-feedstock
  • Update the version
  • Update the SHA256
  • Set the build number 5to 0

Download Binary Distributions

Conda-Forge is handled automatically. We handle wheels.

• Windows wheels from here
• Mac / Linux wheels with python scripts/fetch_wheels.py, from here

Upload to PyPI

Upload the source and wheels simultaneously. Uploading just the source may break some users'
workflows, if they trigger an update but don't have a C-complier

• Assuming you've downloaded everything to dist: twine upload dist/*
• You may want to hide the release until the docs are up and announcement is sent out

Build and Upload the Docs

• Build and upload

cd docs;
./make.py clean; ./make.py; ./make.py zip_html;  ./make.py latex_forced
python make.py upload 0.20.2

Update the Website

• clone the repo: https://github.com/pandas-dev/pandas-website.git
• major only: Move latest.rst to previous.rst
• Update latest.rst
• Update releases.json and pre_release.json (if RC, add to pre_release.json, else make it blank)
• Update _themes/pydata/layout.html to have the most recent minor release of each major version
• commit and push
• build: python make.py html
• upload: python upload.py # TODO: verify this works
• Verify it updated (maybe in an incognito browser to avoid caching)

Announce

• Make sure everything is in place
  • pypi binaries for windows, mac wheels, source
  • docs built and published
  • website updated
• Send an ANN to the mailing list. include links to both release notes and whatsnew.
• send announcements to pydata@googlegroups.com, numpy-discussion@scipy.org, python-announce-list@python.org, scipy-user@scipy.org, pandas-dev@python.org

** Final Version**

• 0.20.3
• 0.20.2
• 0.20.1
• 0.19.2
• 0.19.1
• 0.19.0
• 0.18.1
• 0.18.0
• 0.17.1
• 0.17.0
• 0.16.2
• 0.16.1
• 0.16.0
• 0.15.2
• 0.15.1
• 0.15.0
• 0.14.1
• 0.14.0
• 0.13.1
• 0.13.0
• 0.11.0

** Release Candidates **

• 0.20.0rc1
• 0.18rc2
• 0.18rc1
• 0.17rc2
• 0.17rc1
• 0.16rc1
• 0.15rc1
• 0.14rc1
• 0.13rc1

Start the next release cycle

Only after a major release

When finishing a major release we have a few extra steps to ensure that
the development version is always ahead of the backports version.

• Create a backports branch off the release commmit, e.g. git checkout -b 0.20.x master
• Push that to upstream: git push -u upstream 0.20.x
• Switch back to master and make a new commit to start the next cycle
  • git checkout master
  • git commit --allow-empty -m 'DEV: Start 0.21 cycle'
  • git tag -a v0.21.0.dev0 -m 'Version 0.21.0 start'
  • git push upstream master --follow-tags
• Ensure that a whatsnew file is available for the next major and minor releases

Finish

• Close the Milestone on github
• Close the RLS issue

[jreback]

I would release when you are ready @TomAugspurger I don't think we need an RC.

[jorisvandenbossche]

Made use of some available internet: good to release for me!

If it is not yet tagged, some feedback:

• add a note to the 0.21.0 whatsnew that this is no longer up to date with link to 0.22 whatsnew docs
• the Series.sum (and related) docstring is still wrong regarding return value for empty/all-NA: in the examples in has been changes, but in the explanation of skipna not
• the docstring also inclused a versionadded directive with 0.21.2 -> this should be 0.22.0

[TomAugspurger]

Thanks. Haven’t tagged yet, probably tomorrow morning. I’ll address all those comments and your one from the other thread.

…

________________________________ From: Joris Van den Bossche <notifications@github.com> Sent: Friday, December 29, 2017 9:56:56 PM To: pandas-dev/pandas Cc: Tom Augspurger; Mention Subject: Re: [pandas-dev/pandas] RLS: 0.22.0 (#18985) Made use of some available internet: good to release for me! If it is not yet tagged, some feedback: * add a note to the 0.21.0 whatsnew that this is no longer up to date with link to 0.22 whatsnew docs * the Series.sum (and related) docstring is still wrong regarding return value for empty/all-NA: in the examples in has been changes, but in the explanation of skipna not * the docstring also inclused a versionadded directive with 0.21.2 -> this should be 0.22.0 — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#18985 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/ABQHIuyCoZMrc31nAuAnw4MTjq3HVyidks5tFbSIgaJpZM4RPJvR>.

[TomAugspurger]

@cgohlke is there anything we need to do to get wheels for https://github.com/pandas-dev/pandas/releases/tag/v0.22.0? I don't see them on https://www.lfd.uci.edu/~gohlke/pythonlibs/#pandas currently.

[TomAugspurger]

Nevermind, they are present now. Thanks!

[TomAugspurger]

Wheels are up! https://pypi.org/project/pandas/0.22.0/