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
a61e354e
Unverified
Commit
a61e354e
authored
Nov 05, 2021
by
Henry Schreiner
Committed by
GitHub
Nov 05, 2021
Browse files
docs: touch up manual release suggestion (#3422)
parent
6de30d31
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
6 additions
and
5 deletions
+6
-5
docs/release.rst
docs/release.rst
+4
-5
noxfile.py
noxfile.py
+2
-0
No files found.
docs/release.rst
View file @
a61e354e
...
...
@@ -22,6 +22,9 @@ the version just below.
To release a new version of pybind11:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you don't have nox, you should either use ``pipx run nox`` instead, or use
``pipx install nox`` or ``brew install nox`` (Unix).
- Update the version number
- Update ``PYBIND11_VERSION_MAJOR`` etc. in
``include/pybind11/detail/common.h``. PATCH should be a simple integer.
...
...
@@ -51,14 +54,12 @@ To release a new version of pybind11:
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: 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``.
...
...
@@ -90,9 +91,7 @@ If you need to manually upload releases, you can download the releases from the
.. code-block:: bash
python3 -m pip install build
python3 -m build
PYBIND11_SDIST_GLOBAL=1 python3 -m build
nox -s build
twine upload dist/*
This makes SDists and wheels, and the final line uploads them.
noxfile.py
View file @
a61e354e
...
...
@@ -85,5 +85,7 @@ def build(session: nox.Session) -> None:
"""
session
.
install
(
"build"
)
session
.
log
(
"Building normal files"
)
session
.
run
(
"python"
,
"-m"
,
"build"
)
session
.
log
(
"Building pybind11-global files (PYBIND11_GLOBAL_SDIST=1)"
)
session
.
run
(
"python"
,
"-m"
,
"build"
,
env
=
{
"PYBIND11_GLOBAL_SDIST"
:
"1"
})
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