Skip to content

Commit ba5a12f

Browse files
authored
Update README.md
1 parent ee673ff commit ba5a12f

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,9 +368,32 @@ to get up and running quickly.
368368
git commit -m "updating the version of GAP"
369369
```
370370

371-
### Mac OS
371+
## Mac OS
372372

373373
We do not recommend Apple-shipped compilers and python, and we do not test
374374
compatibility with them. Either use MacPorts or Homebrew to obtain GNU compilers,
375375
and also use the python from there or Anaconda. As of this edit, gcc-8.1 produces as
376376
internal compiler error, but gcc-4.6 through to gcc-7 is fine.
377+
378+
## Triggering the wheel build
379+
380+
Wheels are built on push and pull requests to `public` using [cibuildwheel](https://cibuildwheel.readthedocs.io/en/stable/)
381+
with [this workflow](.github/workflows/build-wheels.yml).
382+
383+
To make a release candidate create a tag with a suffix such as `-rc1` for the first attempt,
384+
push to trigger the build:
385+
386+
```bash
387+
git commit -m 'release v0.x.z-rc1'
388+
git tag v0.x.y-rc1
389+
git push --tags
390+
```
391+
392+
If all goes well, the `.whl` files will show up as assets within a new GitHub
393+
release. The installation process can now be tested locally.
394+
395+
## Release wheels to PyPI
396+
397+
Once everything works correctly, make a full release (i.e. create a tag named
398+
just `v0.x.y` without the `-rc1` suffix). This will trigger the upload of wheels
399+
and source distribution to PyPI.

0 commit comments

Comments
 (0)