conda-smithy is a tool for combining a conda recipe with configurations to build using freely hosted CI services into a single repository, also known as a feedstock.
conda-smithy is still a work-in-progress, but when complete,
- Create a git repo with a conda recipe and the files to run conda builds via CI services.
- Register the repo on github and push it.
- Connect the repo to the CI services travis-ci.org, appveyor.com, circleci.com
The easiest way to install conda-smithy is to use conda and conda-forge:
conda install -n root -c conda-forge conda-smithy
To install conda-smithy from source, see the requirements file in
requirements.txt, clone this
python -m pip install ..
You need a token from github, travis-ci.org, appveyor.com and circleci.com to try out
conda-smithy. The commands which need this will tell you where to get these tokens and where to
place them. If you need help getting tokens please ask on the
conda-forge google group.
You should be able to test parts of
conda-smithy with whatever tokens you have.
For example, you should be able to
conda smithy register-github without the CI service tokens.
Re-rendering an existing feedstock is also possible without CI service tokens set.
Re-rendering an existing feedstock
Periodically feedstocks need to be upgraded to include new features. To do
this we use
conda-smithy to go through a process called re-rendering.
Make sure you have installed
conda-smithy before proceeding.
Re-rendering an existing feedstock is possible without CI service tokens set.
cd <feedstock directory>
conda smithy rerender [--commit]
- Commit and push all changes
Optionally one can commit the changes automatically with
To do this just use the
-c option. By default this will open an editor to make a commit.
It will provide a default commit message and show the changes to be added. If you wish to do this
automatically, please just use
-c auto and it will use the stock commit message.
Making a new feedstock
- Make the feedstock repo:
conda smithy init <directory_of_conda_recipe>. For a recipe called
foo, this creates a directory called
foo-feedstock, populates it with CI setup skeletons, adds the recipe under
recipeand initializes it as a git repo.
- Create a github repo:
conda smithy register-github --organization conda-forge ./foo-feedstock. This requires a github token. You can try it out with a github user account instead of an organization by replacing the organization argument with
--user github_user_name. If you are interested in adding teams for your feedstocks, you can provide the
--add-teamsoption to create them. This can be done when creating the feedstock or after.
- Register the feedstock with CI services:
conda smithy register-ci --organization conda-forge --feedstock_directory ./foo-feedstock. This requires tokens for the CI services. You can give the name of a user instead of organization with
- Specify the feedstock channel and label:
Optionally, you can choose a channel to upload to in
channels: targets: - [target_channel, target_label]
- Re-render the feedstock:
conda smithy rerender --feedstock_directory ./foo-feedstock
- Commit the changes:
cd foo-feedstock && git commit, then push
git push upstream master.
Running a build
When everything is configured you can trigger a build with a push to the feedstock repo on github.
To release a new version of conda-smithy, you can use the
rever release managment tool.
rever in the root repo directory with the version number you want to release.
$ rever 0.1.2