Skip to content

Commit 82dbc5b

Browse files
henryiiihenryiii
authored
ci: releases (pybind#2530)
* ci: releases * docs: minor update form @wjakob * fix: enforce reasonable version of setuptools
1 parent d159a56 commit 82dbc5b

File tree

6 files changed

+164
-75
lines changed

6 files changed

+164
-75
lines changed

‎.github/workflows/configure.yml

-54
Original file line numberDiff line numberDiff line change
@@ -82,57 +82,3 @@ jobs:
8282
working-directory: build dir
8383
if: github.event_name == 'workflow_dispatch'
8484
run: cmake --build . --config Release --target check
85-
86-
# This builds the sdists and wheels and makes sure the files are exactly as
87-
# expected. Using Windows and Python 2.7, since that is often the most
88-
# challenging matrix element.
89-
test-packaging:
90-
name: 🐍 2.7 • 📦 tests • windows-latest
91-
runs-on: windows-latest
92-
93-
steps:
94-
- uses: actions/checkout@v2
95-
96-
- name: Setup 🐍 2.7
97-
uses: actions/setup-python@v2
98-
with:
99-
python-version: 2.7
100-
101-
- name: Prepare env
102-
run: python -m pip install -r tests/requirements.txt --prefer-binary
103-
104-
- name: Python Packaging tests
105-
run: pytest tests/extra_python_package/
106-
107-
108-
# This runs the packaging tests and also builds and saves the packages as
109-
# artifacts.
110-
packaging:
111-
name: 🐍 3.8 • 📦 & 📦 tests • ubuntu-latest
112-
runs-on: ubuntu-latest
113-
114-
steps:
115-
- uses: actions/checkout@v2
116-
117-
- name: Setup 🐍 3.8
118-
uses: actions/setup-python@v2
119-
with:
120-
python-version: 3.8
121-
122-
- name: Prepare env
123-
run: python -m pip install -r tests/requirements.txt build twine --prefer-binary
124-
125-
- name: Python Packaging tests
126-
run: pytest tests/extra_python_package/
127-
128-
- name: Build SDist and wheels
129-
run: |
130-
python -m build -s -w .
131-
PYBIND11_GLOBAL_SDIST=1 python -m build -s -w .
132-
133-
- name: Check metadata
134-
run: twine check dist/*
135-
136-
- uses: actions/upload-artifact@v2
137-
with:
138-
path: dist/*

‎.github/workflows/pip.yml

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
name: Pip
2+
3+
on:
4+
workflow_dispatch:
5+
pull_request:
6+
push:
7+
branches:
8+
- master
9+
- stable
10+
- v*
11+
release:
12+
types:
13+
- published
14+
15+
jobs:
16+
# This builds the sdists and wheels and makes sure the files are exactly as
17+
# expected. Using Windows and Python 2.7, since that is often the most
18+
# challenging matrix element.
19+
test-packaging:
20+
name: 🐍 2.7 • 📦 tests • windows-latest
21+
runs-on: windows-latest
22+
23+
steps:
24+
- uses: actions/checkout@v2
25+
26+
- name: Setup 🐍 2.7
27+
uses: actions/setup-python@v2
28+
with:
29+
python-version: 2.7
30+
31+
- name: Prepare env
32+
run: python -m pip install -r tests/requirements.txt --prefer-binary
33+
34+
- name: Python Packaging tests
35+
run: pytest tests/extra_python_package/
36+
37+
38+
# This runs the packaging tests and also builds and saves the packages as
39+
# artifacts.
40+
packaging:
41+
name: 🐍 3.8 • 📦 & 📦 tests • ubuntu-latest
42+
runs-on: ubuntu-latest
43+
44+
steps:
45+
- uses: actions/checkout@v2
46+
47+
- name: Setup 🐍 3.8
48+
uses: actions/setup-python@v2
49+
with:
50+
python-version: 3.8
51+
52+
- name: Prepare env
53+
run: python -m pip install -r tests/requirements.txt build twine --prefer-binary
54+
55+
- name: Python Packaging tests
56+
run: pytest tests/extra_python_package/
57+
58+
- name: Build SDist and wheels
59+
run: |
60+
python -m build
61+
PYBIND11_GLOBAL_SDIST=1 python -m build
62+
63+
- name: Check metadata
64+
run: twine check dist/*
65+
66+
- uses: actions/upload-artifact@v2
67+
with:
68+
path: dist/*
69+
70+
71+
# When a GitHub release is made, upload the artifacts to PyPI
72+
upload:
73+
name: Upload to PyPI
74+
runs-on: ubuntu-latest
75+
if: github.event_name == 'release' && github.event.action == 'published'
76+
needs: [packaging]
77+
78+
steps:
79+
- uses: actions/setup-python@v2
80+
81+
- uses: actions/download_artifacts@v2
82+
with:
83+
path: dist
84+
name: artifact
85+
86+
- uses: pypa/[email protected]
87+
with:
88+
user: __token__
89+
password: ${{ secrets.pypi_password }}

‎.pre-commit-config.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ repos:
5353

5454
# CMake formatting
5555
- repo: https://github.com/cheshirekow/cmake-format-precommit
56-
rev: v0.6.11
56+
rev: v0.6.13
5757
hooks:
5858
- id: cmake-format
5959
additional_dependencies: [pyyaml]
@@ -62,7 +62,7 @@ repos:
6262

6363
# Checks the manifest for missing files (native support)
6464
- repo: https://github.com/mgedmin/check-manifest
65-
rev: "0.42"
65+
rev: "0.43"
6666
hooks:
6767
- id: check-manifest
6868
# This is a slow hook, so only run this if --hook-stage manual is passed

‎docs/release.rst

+71-17
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,75 @@
1+
On version numbers
2+
^^^^^^^^^^^^^^^^^^
3+
4+
The two version numbers (C++ and Python) must match when combined (checked when
5+
you build the PyPI package), and must be a valid `PEP 440
6+
<https://www.python.org/dev/peps/pep-0440>`_ version when combined.
7+
8+
For example:
9+
10+
.. code-block:: C++
11+
12+
#define PYBIND11_VERSION_MAJOR X
13+
#define PYBIND11_VERSION_MINOR Y
14+
#define PYBIND11_VERSION_PATCH Z.dev1
15+
16+
For beta, ``PYBIND11_VERSION_PATCH`` should be ``Z.b1``. RC's can be ``Z.rc1``.
17+
Always include the dot (even though PEP 440 allows it to be dropped). For a
18+
final release, this must be a simple integer.
19+
20+
121
To release a new version of pybind11:
22+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
223

3-
- Update the version number and push to pypi
4-
- Update ``pybind11/_version.py`` (set release version, remove 'dev').
5-
- Update ``PYBIND11_VERSION_MAJOR`` etc. in ``include/pybind11/detail/common.h``.
6-
- Ensure that all the information in ``setup.py`` is up-to-date.
7-
- Update version in ``docs/conf.py``.
8-
- Tag release date in ``docs/changelog.rst``.
9-
- ``git add`` and ``git commit``.
10-
- if new minor version: ``git checkout -b vX.Y``, ``git push -u origin vX.Y``
11-
- ``git tag -a vX.Y.Z -m 'vX.Y.Z release'``.
24+
- Update the version number
25+
- Update ``PYBIND11_VERSION_MAJOR`` etc. in
26+
``include/pybind11/detail/common.h``. PATCH should be a simple integer.
27+
- Update ``pybind11/_version.py`` (match above)
28+
- Ensure that all the information in ``setup.py`` is up-to-date.
29+
- Add release date in ``docs/changelog.rst``.
30+
- ``git add`` and ``git commit``, ``git push``. **Ensure CI passes**. (If it
31+
fails due to a known flake issue, either ignore or restart CI.)
32+
- Add a release branch if this is a new minor version
33+
- ``git checkout -b vX.Y``, ``git push -u origin vX.Y``
34+
- Update tags
35+
- ``git tag -a vX.Y.Z -m 'vX.Y.Z release'``.
36+
- ``git push --tags``.
37+
- Update stable
38+
- ``git checkout stable``
39+
- ``git merge master``
1240
- ``git push``
13-
- ``git push --tags``.
14-
- ``python setup.py sdist upload``.
15-
- ``python setup.py bdist_wheel upload``.
41+
- Make a GitHub release (this shows up in the UI, sends new release
42+
notifications to users watching releases, and also uploads PyPI packages).
43+
(Note: if you do not use an existing tag, this creates a new lightweight tag
44+
for you, so you could skip the above step).
45+
- GUI method: click "Create a new release" on the far right, fill in the tag
46+
name, fill in a release name like "Version X.Y.Z", and optionally
47+
copy-and-paste the changelog into the description (processed as markdown by
48+
Pandoc). Check "pre-release" if this is a beta/RC.
49+
- CLI method: with ``gh`` installed, run ``gh release create vX.Y.Z -t "Version X.Y.Z"``
50+
If this is a pre-release, add ``-p``.
51+
1652
- Get back to work
17-
- Update ``_version.py`` (add 'dev' and increment minor).
18-
- Update version in ``docs/conf.py``
19-
- Update version macros in ``include/pybind11/common.h``
20-
- ``git add`` and ``git commit``.
21-
``git push``
53+
- Make sure you are on master, not somewhere else: ``git checkout master``
54+
- Update version macros in ``include/pybind11/common.h`` (set PATCH to
55+
``0.dev1`` and increment MINOR).
56+
- Update ``_version.py`` to match
57+
- Add a plot for in-development updates in ``docs/changelog.rst``.
58+
- ``git add``, ``git commit``, ``git push``
59+
60+
If a version branch is updated, remember to set PATCH to ``1.dev1``.
61+
62+
63+
Manual packaging
64+
^^^^^^^^^^^^^^^^
65+
66+
If you need to manually upload releases, you can download the releases from the job artifacts and upload them with twine. You can also make the files locally (not recommended in general, as your local directory is more likely to be "dirty" and SDists love picking up random unrelated/hidden files); this is the procedure:
67+
68+
.. code-block:: bash
69+
70+
python3 -m pip install build
71+
python3 -m build
72+
PYBIND11_SDIST_GLOBAL=1 python3 -m build
73+
twine upload dist/*
74+
75+
This makes SDists and wheels, and the final line uploads them.

‎pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[build-system]
2-
requires = ["setuptools", "wheel", "cmake==3.18.0", "ninja"]
2+
requires = ["setuptools>=42", "wheel", "cmake>=3.18", "ninja"]
33
build-backend = "setuptools.build_meta"

‎tools/pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[build-system]
2-
requires = ["setuptools", "wheel"]
2+
requires = ["setuptools>=42", "wheel"]
33
build-backend = "setuptools.build_meta"

0 commit comments

Comments
 (0)