xref: /gem5/ext/pybind11/docs/release.rst

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 ``PYBIND11_VERSION_MAJOR`` etc. in ``include/pybind11/detail/common.h``.
    - Ensure that all the information in ``setup.py`` is up-to-date.
    - 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
    - download release package from Github: ``wget https://github.com/pybind/pybind11/archive/vX.Y.Z.tar.gz``
    - compute checksum: ``shasum -a 256  vX.Y.Z.tar.gz``
    - change version number and checksum in ``recipe/meta.yml``
- 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``