blob: b31bbe97ebbcb72b327ff14b2fce818494e6331e [file] [log] [blame]
Sylvain Corlay97dc8102016-02-01 09:51:35 -05001To release a new version of pybind11:
2
Sylvain Corlaye6464ad2016-03-08 19:31:52 -05003- Update the version number and push to pypi
Wenzel Jakob40100812016-12-29 23:44:48 +01004 - Update ``pybind11/_version.py`` (set release version, remove 'dev').
Wenzel Jakobdef3c182017-08-31 13:56:57 +02005 - Update ``PYBIND11_VERSION_MAJOR`` etc. in ``include/pybind11/detail/common.h``.
Wenzel Jakob2723a382017-01-01 17:14:27 +01006 - Ensure that all the information in ``setup.py`` is up-to-date.
Wenzel Jakob40100812016-12-29 23:44:48 +01007 - Update version in ``docs/conf.py``.
Wenzel Jakob2c76c692016-05-26 16:50:15 +02008 - Tag release date in ``docs/changelog.rst``.
Sylvain Corlaye6464ad2016-03-08 19:31:52 -05009 - ``git add`` and ``git commit``.
Wenzel Jakoba720a602016-07-12 18:02:13 +020010 - if new minor version: ``git checkout -b vX.Y``, ``git push -u origin vX.Y``
11 - ``git tag -a vX.Y.Z -m 'vX.Y.Z release'``.
Wenzel Jakobace7b432016-05-10 13:09:05 +010012 - ``git push``
13 - ``git push --tags``.
Sylvain Corlaye6464ad2016-03-08 19:31:52 -050014 - ``python setup.py sdist upload``.
15 - ``python setup.py bdist_wheel upload``.
Wenzel Jakob663513c2016-06-14 16:08:31 +020016- Update conda-forge (https://github.com/conda-forge/pybind11-feedstock) via PR
Wenzel Jakob2fb4e952017-08-31 23:05:45 +020017 - download release package from Github: ``wget https://github.com/pybind/pybind11/archive/vX.Y.Z.tar.gz``
18 - compute checksum: ``shasum -a 256 vX.Y.Z.tar.gz``
19 - change version number and checksum in ``recipe/meta.yml``
Sylvain Corlaye6464ad2016-03-08 19:31:52 -050020- Get back to work
21 - Update ``_version.py`` (add 'dev' and increment minor).
Wenzel Jakobf85c5292016-06-14 15:24:47 +020022 - Update version in ``docs/conf.py``
Sylvain Corlaye6464ad2016-03-08 19:31:52 -050023 - Update version macros in ``include/pybind11/common.h``
Wenzel Jakobace7b432016-05-10 13:09:05 +010024 - ``git add`` and ``git commit``.
25 ``git push``