Skip to content

Commit 1127181

Browse files
committed
Update dev docs with key links
1 parent 014502e commit 1127181

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/development.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ that will be performed to be manually specified.
5151
See the `uv version` docs (specifically the `--bump` flag) for the
5252
[list of available bump rules](https://docs.astral.sh/uv/reference/cli/#uv-version).
5353

54+
Releasing also includes building of wheels for major operating systems and supported Python versions.
55+
This is done thanks to [cibuildwheel](https://cibuildwheel.pypa.io/), an incredible service.
56+
The wheel building can be quite tricky and fiddly.
57+
If there are issues, we recommend starting with the [cibuildwheel](https://cibuildwheel.pypa.io/) docs
58+
or raising an issue to discuss with the other maintainers.
59+
5460
### Standard process
5561

5662
The steps required are the following:
@@ -65,7 +71,8 @@ The steps required are the following:
6571
(see here:
6672
[project releases](https://github.com/openscm/example-fgen-basic/releases)).
6773
Once you are happy with the release
68-
(removed placeholders, added key announcements etc.)
74+
(removed placeholders, added key announcements,
75+
checked that all the expected wheels and source distribution is there etc.)
6976
then hit 'Publish release'.
7077
This triggers a release to PyPI
7178
(which you can then add to the release if you want).

0 commit comments

Comments
 (0)