Testing Recipes Locally¶
Queue times on CircleCI may sometimes make it more convenient and faster to work on complex packages locally. There are several ways to do so, each with their own caveats.
You can execute an almost exact copy of our Linux build pipeline by
installing the CircleCI client locally and running it from the
folder where your copy of
# Ensure the build container is up-to-date docker pull quay.io/bioconda/bioconda-utils-build-env:latest # Run the build locally circleci build
You will have to have “commited” some changes as described above. The
command will run our build system just as it is run online in a docker
container. It will detect which recipes where modified using the
git history and proceed with linting and building those.
Please note that this will only run the Linux build steps.
You can use Docker volume bind-mounts to capture the local package channel with the newly built packages:
mkdir /tmp/conda-bld circleci build --volume /tmp/conda-bld:/opt/conda/conda-bld
After a successful build, you can then install from the local channel by providing the path to it:
conda install -c file:///tmp/conda-bld your-package
Note that if the package also exists with the same version or a newer
version in remote channels, then you may need to specify the exact local
build string in your package spec to ensure your local build is
your-package ==x.y.z build_string. See
Conda package specification for more details on how to specify
Due to technical limitations of the Circle CI client, the above test does
not run the more stringent
mulled-build tests. To do so, use the
./bootstrap.py /tmp/miniconda source ~/.config/bioconda/activate # optional linting bioconda-utils lint --git-range master # build and test bioconda-utils build --docker --mulled-test --git-range master
The above commands do the following:
- Install a separate miniconda installation in a temporary directory:
Set up bioconda channels,
install bioconda-utils dependencies into the root environment of that installation,
and write the file
Source that new file to specifically activate the root environment of the new installation
bioconda-utilsin the new installation:
lintcommand will run the lint checks on your recipes
buildcommand will run the build pipeline
You can select recipes to lint/build using
--git-range master, which which will select those recipes that have been changed between your master and your branch. Or you can specify recipes directly using
--packages mypackage1 mypackage2.
bioconda-utilsto execute the build within a docker container. On MacOS, this will do a Linux build in addition to the local MacOS build.
bioconda-utilsto repeat the recipes test in a clean, freshly created docker container to ensure that the package does not depend on anything that happens to be included in the build container.
If you do not have access to Docker, you can still run the basic test by
telling the bootstrap setup to not use docker, and by excluding the
--mulled-test arguments in the last command:
./bootstrap.py --no-docker /tmp/miniconda source ~/.config/bioconda/activate bioconda-utils build --git-range master
Explain how to use
conda debugfor difficult recipes.
Explain how to create patch series.