Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
gaoqiong
pybind11
Commits
74935f8d
Unverified
Commit
74935f8d
authored
Jul 17, 2021
by
Henry Schreiner
Committed by
GitHub
Jul 17, 2021
Browse files
chore: post-release (#3128)
parent
65e95ea8
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
41 additions
and
34 deletions
+41
-34
docs/changelog.rst
docs/changelog.rst
+5
-0
docs/release.rst
docs/release.rst
+33
-31
include/pybind11/detail/common.h
include/pybind11/detail/common.h
+2
-2
pybind11/_version.py
pybind11/_version.py
+1
-1
No files found.
docs/changelog.rst
View file @
74935f8d
...
@@ -6,6 +6,11 @@ Changelog
...
@@ -6,6 +6,11 @@ Changelog
Starting with version 1.8.0, pybind11 releases use a `semantic versioning
Starting with version 1.8.0, pybind11 releases use a `semantic versioning
<http://semver.org>`_ policy.
<http://semver.org>`_ policy.
Next version (WIP)
------------------
v2.7.0 (Jul 16, 2021)
v2.7.0 (Jul 16, 2021)
---------------------
---------------------
...
...
docs/release.rst
View file @
74935f8d
...
@@ -15,31 +15,33 @@ For example:
...
@@ -15,31 +15,33 @@ For example:
For beta, ``PYBIND11_VERSION_PATCH`` should be ``Z.b1``. RC's can be ``Z.rc1``.
For beta, ``PYBIND11_VERSION_PATCH`` should be ``Z.b1``. RC's can be ``Z.rc1``.
Always include the dot (even though PEP 440 allows it to be dropped). For a
Always include the dot (even though PEP 440 allows it to be dropped). For a
final release, this must be a simple integer.
final release, this must be a simple integer. There is also a HEX version of
the version just below.
To release a new version of pybind11:
To release a new version of pybind11:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Update the version number
- Update the version number
- Update ``PYBIND11_VERSION_MAJOR`` etc. in
- Update ``PYBIND11_VERSION_MAJOR`` etc. in
``include/pybind11/detail/common.h``. PATCH should be a simple integer.
``include/pybind11/detail/common.h``. PATCH should be a simple integer.
- Update ``pybind11/_version.py`` (match above)
- Update the version HEX just below, as well.
- Ensure that all the information in ``setup.cfg`` is up-to-date, like
- Update ``pybind11/_version.py`` (match above)
supported Python versions.
- Ensure that all the information in ``setup.cfg`` is up-to-date, like
- Add release date in ``docs/changelog.rst``.
supported Python versions.
- Check to make sure
- Add release date in ``docs/changelog.rst``.
`needs-changelog <https://github.com/pybind/pybind11/pulls?q=is%3Apr+is%3Aclosed+label%3A%22needs+changelog%22>`_
- Check to make sure
issues are entered in the changelog (clear the label when done).
`needs-changelog <https://github.com/pybind/pybind11/pulls?q=is%3Apr+is%3Aclosed+label%3A%22needs+changelog%22>`_
- ``git add`` and ``git commit``, ``git push``. **Ensure CI passes**. (If it
issues are entered in the changelog (clear the label when done).
fails due to a known flake issue, either ignore or restart CI.)
- ``git add`` and ``git commit``, ``git push``. **Ensure CI passes**. (If it
fails due to a known flake issue, either ignore or restart CI.)
- Add a release branch if this is a new minor version, or update the existing release branch if it is a patch version
- Add a release branch if this is a new minor version, or update the existing release branch if it is a patch version
- New branch: ``git checkout -b vX.Y``, ``git push -u origin vX.Y``
- New branch: ``git checkout -b vX.Y``, ``git push -u origin vX.Y``
- Update branch: ``git checkout vX.Y``, ``git merge <release branch>``, ``git push``
- Update branch: ``git checkout vX.Y``, ``git merge <release branch>``, ``git push``
- Update tags (optional; if you skip this, the GitHub release makes a
- Update tags (optional; if you skip this, the GitHub release makes a
non-annotated tag for you)
non-annotated tag for you)
- ``git tag -a vX.Y.Z -m 'vX.Y.Z release'``.
- ``git tag -a vX.Y.Z -m 'vX.Y.Z release'``.
- ``git push --tags``.
- ``git push --tags``.
- Update stable
- Update stable
- ``git checkout stable``
- ``git checkout stable``
- ``git merge master``
- ``git merge master``
...
@@ -48,22 +50,22 @@ To release a new version of pybind11:
...
@@ -48,22 +50,22 @@ To release a new version of pybind11:
notifications to users watching releases, and also uploads PyPI packages).
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
(Note: if you do not use an existing tag, this creates a new lightweight tag
for you, so you could skip the above step).
for you, so you could skip the above step).
- GUI method: click "Create a new release" on the far right, fill in the tag
- 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 (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
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
the description (processed as markdown by Pandoc). Check "pre-release" if
this is a beta/RC. You can get partway there with
this is a beta/RC. You can get partway there with
``cat docs/changelog.rst | pandoc -f rst -t
markdown
``.
``cat docs/changelog.rst | pandoc -f rst -t
gfm
``.
- CLI method: with ``gh`` installed, run ``gh release create vX.Y.Z -t "Version X.Y.Z"``
- 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``.
If this is a pre-release, add ``-p``.
- Get back to work
- Get back to work
- Make sure you are on master, not somewhere else: ``git checkout master``
- Make sure you are on master, not somewhere else: ``git checkout master``
- Update version macros in ``include/pybind11/detail/common.h`` (set PATCH to
- Update version macros in ``include/pybind11/detail/common.h`` (set PATCH to
``0.dev1`` and increment MINOR).
``0.dev1`` and increment MINOR).
- Update ``_version.py`` to match
- Update ``_version.py`` to match
- Add a spot for in-development updates in ``docs/changelog.rst``.
- Add a spot for in-development updates in ``docs/changelog.rst``.
- ``git add``, ``git commit``, ``git push``
- ``git add``, ``git commit``, ``git push``
If a version branch is updated, remember to set PATCH to ``1.dev1``.
If a version branch is updated, remember to set PATCH to ``1.dev1``.
...
...
include/pybind11/detail/common.h
View file @
74935f8d
...
@@ -11,11 +11,11 @@
...
@@ -11,11 +11,11 @@
#define PYBIND11_VERSION_MAJOR 2
#define PYBIND11_VERSION_MAJOR 2
#define PYBIND11_VERSION_MINOR 7
#define PYBIND11_VERSION_MINOR 7
#define PYBIND11_VERSION_PATCH
0
#define PYBIND11_VERSION_PATCH
1.dev1
// Similar to Python's convention: https://docs.python.org/3/c-api/apiabiversion.html
// Similar to Python's convention: https://docs.python.org/3/c-api/apiabiversion.html
// Additional convention: 0xD = dev
// Additional convention: 0xD = dev
#define PYBIND11_VERSION_HEX 0x02070
000
#define PYBIND11_VERSION_HEX 0x02070
1D1
#define PYBIND11_NAMESPACE_BEGIN(name) namespace name {
#define PYBIND11_NAMESPACE_BEGIN(name) namespace name {
#define PYBIND11_NAMESPACE_END(name) }
#define PYBIND11_NAMESPACE_END(name) }
...
...
pybind11/_version.py
View file @
74935f8d
...
@@ -8,5 +8,5 @@ def _to_int(s):
...
@@ -8,5 +8,5 @@ def _to_int(s):
return
s
return
s
__version__
=
"2.7.
0
"
__version__
=
"2.7.
1.dev1
"
version_info
=
tuple
(
_to_int
(
s
)
for
s
in
__version__
.
split
(
"."
))
version_info
=
tuple
(
_to_int
(
s
)
for
s
in
__version__
.
split
(
"."
))
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment