Skip to content

Commit

Permalink
[skip ci] Tweaks in preparation for the 2.8.1 release. (#3421)
Browse files Browse the repository at this point in the history
  • Loading branch information
rwgk committed Oct 27, 2021
1 parent f1594cb commit f7b4996
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/changelog.rst
Expand Up @@ -10,7 +10,7 @@ Starting with version 1.8.0, pybind11 releases use a `semantic versioning
IN DEVELOPMENT
--------------

v2.8.0 (Oct 27, 2021)
v2.8.1 (Oct 27, 2021)
---------------------

Changes and additions:
Expand Down
22 changes: 12 additions & 10 deletions docs/release.rst
Expand Up @@ -27,7 +27,7 @@ To release a new version of pybind11:
``include/pybind11/detail/common.h``. PATCH should be a simple integer.
- Update the version HEX just below, as well.
- Update ``pybind11/_version.py`` (match above)
- Run ``nox -s tests_packaging``` to ensure this was done correctly.
- Run ``nox -s tests_packaging`` to ensure this was done correctly.
- Ensure that all the information in ``setup.cfg`` is up-to-date, like
supported Python versions.
- Add release date in ``docs/changelog.rst``.
Expand All @@ -50,13 +50,15 @@ To release a new version of pybind11:
- Make a GitHub release (this shows up in the UI, sends new release
notifications to users watching releases, and also uploads PyPI packages).
(Note: if you do not use an existing tag, this creates a new lightweight tag
for you, so you could skip the above step).
- GUI method: click "Create a new release" on the far right, fill in the tag
name (if you didn't tag above, it will be made here), fill in a release
name like "Version X.Y.Z", and optionally copy-and-paste the changelog into
the description (processed as markdown by Pandoc). Check "pre-release" if
this is a beta/RC. You can get partway there with
``cat docs/changelog.rst | pandoc -f rst -t gfm``.
for you, so you could skip the above step.)

- GUI method: Under `releases <https://github.com/pybind/pybind11/releases>`_
click "Draft a new release" on the far right, fill in the tag name
(if you didn't tag above, it will be made here), fill in a release name
like "Version X.Y.Z", and copy-and-paste the markdown-formatted (!) changelog
into the description (usually ``cat docs/changelog.rst | pandoc -f rst -t gfm``).
Check "pre-release" if this is a beta/RC.

- CLI method: with ``gh`` installed, run ``gh release create vX.Y.Z -t "Version X.Y.Z"``
If this is a pre-release, add ``-p``.

Expand All @@ -65,15 +67,15 @@ To release a new version of pybind11:
- Update version macros in ``include/pybind11/detail/common.h`` (set PATCH to
``0.dev1`` and increment MINOR).
- Update ``_version.py`` to match
- Run ``nox -s tests_packaging``` to ensure this was done correctly.
- Run ``nox -s tests_packaging`` to ensure this was done correctly.
- Add a spot for in-development updates in ``docs/changelog.rst``.
- ``git add``, ``git commit``, ``git push``

If a version branch is updated, remember to set PATCH to ``1.dev1``.

If you'd like to bump homebrew, run:

.. code-block::
.. code-block:: console
brew bump-formula-pr --url https://github.com/pybind/pybind11/archive/vX.Y.Z.tar.gz
Expand Down
6 changes: 3 additions & 3 deletions include/pybind11/detail/common.h
Expand Up @@ -10,12 +10,12 @@
#pragma once

#define PYBIND11_VERSION_MAJOR 2
#define PYBIND11_VERSION_MINOR 9
#define PYBIND11_VERSION_PATCH 0.dev1
#define PYBIND11_VERSION_MINOR 8
#define PYBIND11_VERSION_PATCH 1

// Similar to Python's convention: https://docs.python.org/3/c-api/apiabiversion.html
// Additional convention: 0xD = dev
#define PYBIND11_VERSION_HEX 0x020900D1
#define PYBIND11_VERSION_HEX 0x02080100

#define PYBIND11_NAMESPACE_BEGIN(name) namespace name {
#define PYBIND11_NAMESPACE_END(name) }
Expand Down
2 changes: 1 addition & 1 deletion pybind11/_version.py
Expand Up @@ -8,5 +8,5 @@ def _to_int(s):
return s


__version__ = "2.9.0.dev1"
__version__ = "2.8.1"
version_info = tuple(_to_int(s) for s in __version__.split("."))

0 comments on commit f7b4996

Please sign in to comment.