Skip to content

Commit a61e354

Browse files
authored
docs: touch up manual release suggestion (#3422)
1 parent 6de30d3 commit a61e354

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

docs/release.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ the version just below.
2222
To release a new version of pybind11:
2323
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2424

25+
If you don't have nox, you should either use ``pipx run nox`` instead, or use
26+
``pipx install nox`` or ``brew install nox`` (Unix).
27+
2528
- Update the version number
2629
- Update ``PYBIND11_VERSION_MAJOR`` etc. in
2730
``include/pybind11/detail/common.h``. PATCH should be a simple integer.
@@ -51,14 +54,12 @@ To release a new version of pybind11:
5154
notifications to users watching releases, and also uploads PyPI packages).
5255
(Note: if you do not use an existing tag, this creates a new lightweight tag
5356
for you, so you could skip the above step.)
54-
5557
- GUI method: Under `releases <https://github.com/pybind/pybind11/releases>`_
5658
click "Draft a new release" on the far right, fill in the tag name
5759
(if you didn't tag above, it will be made here), fill in a release name
5860
like "Version X.Y.Z", and copy-and-paste the markdown-formatted (!) changelog
5961
into the description (usually ``cat docs/changelog.rst | pandoc -f rst -t gfm``).
6062
Check "pre-release" if this is a beta/RC.
61-
6263
- CLI method: with ``gh`` installed, run ``gh release create vX.Y.Z -t "Version X.Y.Z"``
6364
If this is a pre-release, add ``-p``.
6465

@@ -90,9 +91,7 @@ If you need to manually upload releases, you can download the releases from the
9091

9192
.. code-block:: bash
9293
93-
python3 -m pip install build
94-
python3 -m build
95-
PYBIND11_SDIST_GLOBAL=1 python3 -m build
94+
nox -s build
9695
twine upload dist/*
9796
9897
This makes SDists and wheels, and the final line uploads them.

noxfile.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,5 +85,7 @@ def build(session: nox.Session) -> None:
8585
"""
8686

8787
session.install("build")
88+
session.log("Building normal files")
8889
session.run("python", "-m", "build")
90+
session.log("Building pybind11-global files (PYBIND11_GLOBAL_SDIST=1)")
8991
session.run("python", "-m", "build", env={"PYBIND11_GLOBAL_SDIST": "1"})

0 commit comments

Comments
 (0)