One-time setup

Git and GitHub (one-time setup)

If you are a bioconda team member then you have push access to the repo. In this case you can clone the bioconda-recipes repo.

Decide whether you’ll work on a clone or a fork.

Choose a clone if:

  • You are a bioconda team member. Team members have write access to branches other than the master and bulk branches.

Choose a fork if:

  • you are not yet a member of the bioconda team

  • you expect to do lots of testing or lots of troubleshooting. This will allow you to use your own quota on Circle CI, so your builds will likely happen faster and you won’t be consuming the limited bioconda quota.

Using a clone

Clone the main repo:

git clone https://github.com/bioconda/bioconda-recipes.git

You can now move on to installing requirements (next section).

Using a fork

If you do not have push access (see above), then create a fork of bioconda-recipes on GitHub. Then clone it locally:

git clone https://github.com/<USERNAME>/bioconda-recipes.git

Then add the main bioconda-recipes repo as an upstream remote to more easily update your branch with the upstream master branch:

cd bioconda-recipes
git remote add upstream https://github.com/bioconda/bioconda-recipes.git

Install the Circle CI client (optional)

Queue times on CircleCI may sometimes make it more convenient and faster to work on complex packages locally. 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 bioconda-recipes resides:

circleci build

Should you encounter “weird” errors, try updating your local copy of the build environment image:

docker pull bioconda/bioconda-utils-build-env:latest

If the error persists, ask for help on our Gitter channel and/or file an issue at bioconda-utils.

Request to be added to the bioconda team (optional)

While not required, you can be added to bioconda by pinging @bioconda/core in a pull request. Members of the bioconda team can merge their own recipes once linting and testing steps.