Maintainer information#

Releasing#

A release is built and published by the “Wheels and source distribution” workflow of GitHub Actions, from a tag that must be the version of the package, __version__ in sklr/__init__.py. Before uploading anything, the workflow checks the tag, and that there is a wheel for every platform and Python version.

Generate the release history of the version from the changelog fragments. towncrier writes it into the file of its minor release in doc/whats_new, above the previous versions and dated in the current month, and removes the fragments with git rm. Review the generated section and commit it, along with __version__ set to the version:
```
$ towncrier build --version <version>
```

Create the tag on the commit to release and push it:

$ git tag -s <version> -m "scikit-lr <version>"
$ git push origin <version>

Run the workflow by hand from the tag, with testpypi as the repository to upload the distributions to. It builds and tests the wheels and the source distribution, uploads them to TestPyPI, then installs the release from there and runs the tests again. This checks what testing the files alone cannot: that the index accepts them, that pip selects the right wheel, and that the dependencies are resolved from PyPI.
```
$ gh workflow run wheels.yml --ref <version> -f publish=testpypi
```
If it passes, publish a GitHub release from the same tag. The workflow builds and tests the distributions again, and then waits for a maintainer to approve the deployment to the pypi environment before uploading them to PyPI. A version cannot be uploaded again to PyPI, even after deleting it, so this is the last chance to stop the release.

When the development of a new minor release starts, add its file to doc/whats_new, with a header like the one of the previous file, list it in doc/whats_new.rst, and point filename in [tool.towncrier] of pyproject.toml to it, so that the fragments are written there.

The project uploads to PyPI and TestPyPI with trusted publishing, so no token is stored in the repository: each index only accepts the uploads of this workflow from the environment of the same name.

Publishing the GitHub release also makes the “Documentation” workflow build the documentation of the tag and publish it on GitHub Pages, in the directory of its minor release. A final release, not a pre-release, also becomes the stable version, where the root of the site redirects to, unless a newer minor release already is. The pushes to the development branch publish the development version.

Bundled libraries#

The tools that repair the wheels bundle with them the OpenMP runtime of their platform: libgomp on Linux, libomp on macOS and vcomp140.dll on Windows. Its license is appended to the license of scikit-lr in the wheels, from the files in build_tools/wheels, and the workflow checks that each wheel has the runtime of its platform and its license. On macOS, the runtime of LLVM is installed from conda-forge before building, in its oldest version for each architecture, so that it supports the oldest macOS version of the wheels. If the wheels bundle another library, add its license to those files.