summaryrefslogtreecommitdiff
path: root/ext/pybind11/docs/release.rst
diff options
context:
space:
mode:
Diffstat (limited to 'ext/pybind11/docs/release.rst')
-rw-r--r--ext/pybind11/docs/release.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/ext/pybind11/docs/release.rst b/ext/pybind11/docs/release.rst
new file mode 100644
index 000000000..a15504ea8
--- /dev/null
+++ b/ext/pybind11/docs/release.rst
@@ -0,0 +1,22 @@
+To release a new version of pybind11:
+
+- Update the version number and push to pypi
+ - Update ``pybind11/_version.py`` (set release version, remove 'dev')
+ - Update version in ``docs/conf.py``
+ - Tag release date in ``docs/changelog.rst``.
+ - ``git add`` and ``git commit``.
+ - if new minor version: ``git checkout -b vX.Y``, ``git push -u origin vX.Y``
+ - ``git tag -a vX.Y.Z -m 'vX.Y.Z release'``.
+ - ``git push``
+ - ``git push --tags``.
+ - ``python setup.py sdist upload``.
+ - ``python setup.py bdist_wheel upload``.
+- Update conda-forge (https://github.com/conda-forge/pybind11-feedstock) via PR
+ - change version number in ``recipe/meta.yml``
+ - update checksum to match the one computed by pypi
+- Get back to work
+ - Update ``_version.py`` (add 'dev' and increment minor).
+ - Update version in ``docs/conf.py``
+ - Update version macros in ``include/pybind11/common.h``
+ - ``git add`` and ``git commit``.
+ ``git push``