############################################ Building and uploading scikit-umfpack wheels ############################################
We automate wheel building using this custom github repository that builds on the travis-ci OSX machines and the travis-ci Linux machines.
The travis-ci interface for the builds is https://travis-ci.org/scikit-umfpack/scikit-umfpack-wheels
Appveyor interface at https://ci.appveyor.com/project/scikit-umfpack/scikit-umfpack-wheels
The driving github repository is https://github.com/scikit-umfpack/scikit-umfpack-wheels
There are two important branches:
master
- for building releases;daily
- for daily builds.Travis-CI builds the daily
branch - er - daily, via a Travis-CI cron job <https://docs.travis-ci.com/user/cron-jobs/>
_ to check that we can build
against current scikit-umfpack master. When trying to fix builds against
master, or developing new CI build machinery, please use the daily
branch.
Builds from the daily
branch upload to a Rackspace container for
pre-releases at
https://7933911d6844c6c53a7d-47bd50c35cd79bd838daf386af554a83.ssl.cf2.rackcdn.com
Meanwhile, we usually leave the master
branch in a state where it can
build the last release.
Builds from the master
branch upload to a Rackspace container for releases
at
https://3f23b170c54c2533c070-1c8a9b3114517dc5fe17b7c3f8c63a43.ssl.cf2.rackcdn.com
Before releasing, we merge daily
into master
.
Therefore, you will usually want to submit pull requests to the daily
branch, for testing.
The wheel-building repository:
repair
(Manylinux1_). delocate
and auditwheel
copy the required dynamic
libraries into the wheel and relinks the extension modules against the
copied libraries;The resulting wheels are therefore self-contained and do not need any external dynamic libraries apart from those provided as standard by OSX / Linux as defined by the manylinux1 standard.
The .travis.yml
file in this repository has a line containing the API key
for the Rackspace container encrypted with an RSA key that is unique to the
repository - see https://docs.travis-ci.com/user/encryption-keys. This
encrypted key gives the travis build permission to upload to the Rackspace
containers we use to house the uploads.
You will likely want to edit the .travis.yml
and appveyor.yml
files to
specify the BUILD_COMMIT
before triggering a build - see below.
You will need write permission to the github repository to trigger new builds on the travis-ci interface. Contact us on the mailing list if you need this.
You can trigger a build by:
scikit-umfpack-wheels
repository (e.g. with git commit --allow-empty
); orIn general, it is better to trigger a build with a commit, because this makes a new set of build products and logs, keeping the old ones for reference. Keeping the old build logs helps us keep track of previous problems and successful builds.
The scikit-umfpack-wheels
repository will build the commit specified in the
BUILD_COMMIT
at the top of the .travis.yml
file and appveyor.yml
files. This can be any naming of a commit, including branch name, tag name or
commit hash.
Note: when making a scikit-umfpack release, it's best to only push the commit (not the
tag) of the release to the scikit-umfpack
repo, then change BUILD_COMMIT
to the
commit hash, and only after all wheel builds completed successfully push the
release tag to the repo. This avoids having to move or delete the tag in case
of an unexpected build/test issue.
Be careful, these links point to containers on a distributed content delivery network. It can take up to 15 minutes for the new wheel file to get updated into the containers at the links above.
When the wheels are updated, you can download them to your machine manually, and then upload them manually to pypi, or by using twine_. You can also use a script for doing this, housed at : https://github.com/MacPython/terryfy/blob/master/wheel-uploader
For the wheel-uploader
script, you'll need twine and `beautiful soup 4