This document guides a contributor through creating a release of BeakerX.
Review README.md
and make sure that all dependencies are installed.
Update the version in beakerx/beakerx/_version.py
and
beakerx/js/package.json
. Commit the change and push the git tag.
git clean -xfd
cd beakerx
python setup.py sdist
python setup.py bdist_wheel --universal
Make a test installation with pip into a fresh environment, if it works then continue with:
pip install twine
twine upload dist/*
# get the sha256 hash for conda-forge install
shasum -a 256 dist/*.tar.gz
Update the feedstock repo:
- Make a branch or fork of https://github.com/twosigma/beakerx-feedstock.
- Update the
version
andsha256
variable values inrecipe/meta.yaml
. Return build number to 0.
Then test it locally:
# outside of beakerx conda environment
conda install conda-build
conda upgrade conda
conda upgrade conda-build
# inside of beakerx env and beakerx project root
conda build --python 3.5 PATH_TO_RECIPE
# conda-build will output something like `anaconda upload PATH_TO_beakerx-VERSION-py35HASH.tar.bz2`
conda install --use-local beakerx
- Then commit changes and submit a PR upstream to https://github.com/conda-forge/beakerx-feedstock for the new version.
- After CI passes, merge the PR.
To update the embedded version of our widget library:
- Do a full build.
- Run
(cd beakerx/js; npm publish)
(cd kernel; gradle clean)
docker build -t beakerx-base -f docker/base/Dockerfile .
docker build -t beakerx -f docker/Dockerfile .
docker run -p 8888:8888 beakerx
Test it, then
docker tag beakerx beakerx/beakerx
docker push beakerx/beakerx
Update description/version on Docker Hub