Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
P
pybind11
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
open
pybind11
Commits
a61e354e
Unverified
Commit
a61e354e
authored
Nov 05, 2021
by
Henry Schreiner
Committed by
GitHub
Nov 05, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: touch up manual release suggestion (#3422)
parent
6de30d31
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
6 additions
and
5 deletions
+6
-5
docs/release.rst
+4
-5
noxfile.py
+2
-0
No files found.
docs/release.rst
View file @
a61e354e
...
@@ -22,6 +22,9 @@ the version just below.
...
@@ -22,6 +22,9 @@ the version just below.
To release a new version of pybind11:
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 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.
...
@@ -51,14 +54,12 @@ To release a new version of pybind11:
...
@@ -51,14 +54,12 @@ 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: Under `releases <https://github.com/pybind/pybind11/releases>`_
- GUI method: Under `releases <https://github.com/pybind/pybind11/releases>`_
click "Draft a new release" on the far right, fill in the tag name
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
(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
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``).
into the description (usually ``cat docs/changelog.rst | pandoc -f rst -t gfm``).
Check "pre-release" if this is a beta/RC.
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"``
- 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``.
...
@@ -90,9 +91,7 @@ If you need to manually upload releases, you can download the releases from the
...
@@ -90,9 +91,7 @@ If you need to manually upload releases, you can download the releases from the
.. code-block:: bash
.. code-block:: bash
python3 -m pip install build
nox -s build
python3 -m build
PYBIND11_SDIST_GLOBAL=1 python3 -m build
twine upload dist/*
twine upload dist/*
This makes SDists and wheels, and the final line uploads them.
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:
...
@@ -85,5 +85,7 @@ def build(session: nox.Session) -> None:
"""
"""
session
.
install
(
"build"
)
session
.
install
(
"build"
)
session
.
log
(
"Building normal files"
)
session
.
run
(
"python"
,
"-m"
,
"build"
)
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"
})
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