Administration
This document is only of interest to people developing hipercow
and administering the cluster. If you are a user, none of the commands here are for you.
Making a release
- Bump the version number using
hatch version
- Commit and push to GitHub, merge the PR
- Create a new release from the release page
- In "Choose a tag" add
v1.2.3
or whatever your version will be - this is created on publish - Add the release number into the "Release title"
- Describe changes (you may want to use the "Generate release notes" button)
- This will trigger the release action
- In a few minutes the new version is available at its PyPI page and can be installed with
pip
Updating the bootstrap
In general, we'll want the bootstrap updated from the released versions of the package from PyPI. In the R version of the project though, we have found it useful to have the concept of a development bootstrap, and the most flexible installation approach would be from disk.
If the version of hipercow
is on PyPI, you should be able to run, from anywhere:
hipercow dide bootstrap
which will update the bootstrap libraries for all supported versions.
If you want to use the current development sources (this will be more useful once we have the development bootstrap up and running: mrc-6288
) you can do
hatch run build
hipercow dide bootstrap --force dist/hipercow-0.0.3-py3-none-any.whl
but replacing the version number (0.0.3
) as required. The --force
is required if you are installing the same version number for a second time.