Skip to main content

Maintaining packages

Important notes​

Packages on conda-forge are immutable​

As a matter of policy, we do not allow edits or the deletion of packages on conda-forge. This policy is very important as it increases the reliability and reproducibility of conda environments made with the conda-forge channel. Note that because of this policy, our upload scripts will refuse to upload packages which already exist on the conda-forge channel.

If you need to remove a package, please see the section on marking packages broken.

Forking and pull requests​

All maintainers are given push access to the feedstocks that they maintain. This means that a maintainer can create branches in the main repo. For updates, using a branch in the main repo is discouraged because,

  1. CI is run on both the branch and the PR.

    This wastes CI resources

  2. Branches are automatically published.

    This means if you push a version update to a branch and then create a PR, conda packages will be published to anaconda.org before the PR is merged.

Important

For these reasons, maintainers are asked to fork the feedstock to their personal account, push to a branch in the fork and then open a PR to the conda-forge repo.

Pushing to regro-cf-autotick-bot branch​

When a new version of a package is released on PyPI/CRAN/.., we have a bot that automatically creates version updates for the feedstock. In most cases you can simply merge this PR and it should include all changes. When certain things have changed upstream, e.g. the dependencies, you will still have to do changes to the created PR. As feedstock maintainer, you don't have to create a new PR for that but can simply push to the branch the bot created. There are two alternatives to push to the branch of the bot:

  1. Manually setting up git remotes:

    • Clone the conda-forge feedstock repository

    • Add the remote of the bot: git remote add regro-cf-autotick-bot [email protected]:regro-cf-autotick-bot/<package>-feedstock.git

      Important

      It is not possible to push to a GitHub repository using the git:// protocol. See Which remote URL should I use? for instructions on using the https:// protocol if you have enabled two-factor authentication.

    • Fetch the remote: git fetch regro-cf-autotick-bot

    • Checkout the branch of the PR, git should automatically link it to the regro-cf-autotick-bot remote if this is the only remote with a branch of that name.

    • If there are multiple remotes with this branch name, you need to first checkout the remote branch and then turn it into a local branch: git checkout regro-cf-autotick-bot/<branch> && git checkout -b <branch>

    • Commit and push on that branch, if the remote was not correctly setup, use git push -u regro-cf-autotick-bot <branch>.

  2. Using Github's hub tool (which conda-forge ships! conda install hub -c conda-forge):

    • Clone the conda-forge feedstock repository
    • Checkout the correct branch with remote: hub pr checkout 12 where 12 is the ID of the PR.
    • Commit and push on this branch, the remote is automatically set up to push to regro-cf-autotick-bot's fork.

How does regro-cf-autotick-bot create automatic version updates?​

The regro-cf-autotick-bot continuously searches on a loop for any PyPI releases, GitHub releases, and any other sources of versions when any updates are released. The source code that gets executed in the loop comes from the cf-scripts repository, which contains the code to detect versions and submit PRs. Visit cf-scripts to read more about it.

The bot creates updates via inspection of the upstream release and will always update the source section and build version in the recipe metadata. As an experimental feature, the autotick bot can also be configured to verify or update the recipe's requirements for Grayskull-compatible recipes. This may help maintain packages with frequent requirements changes or specific requirements version pins, however this feature is not as extensively verified and proposed updates should be reviewed. (See the bot section in conda-forge.yml)

Sometimes the bot may take several hours to search for these updates. You can also check status of version updates for all the pending version updates. These version updates are pending either because an updated version was found, but a PR wasn't opened yet, or because the bot might have had an error while making the PR. If you can't find a version here, then the chances are that the bot couldn't find it either.

The bot stops making version update PRs when the package feedstock has three or more open version update PRs. The package's maintainer should close or merge those PRs for the bot to work correctly for future version updates.

Example workflow for updating a package​

Here we assume that you would like to update the feedstock <feedstock>. Feedstock is a placeholder and can e.g. be replaced by numpy-feedstock.

  1. Forking the feedstock

    Before you can submit your first PR, you have to fork conda-forge's feedstock.

    • Navigate to https://github.com/conda-forge/ in your favorite web browser and click the fork button.
    • You now have a clone of the feedstock in https://github.com/<your-github-id>/<feedstock> under your control.
    • Connect to the feedstock from your computer by using git clone https://github.com/<your-github-id>/<feedstock>.

  2. Syncing your fork with conda-forge's feedstock

    This step is only required if you have forked some time ago and your fork is missing commits from the feedstock at conda-forge.

    • Make sure you are on the main branch: git checkout main
    • Register conda-forge's feedstock with git remote add upstream https://github.com/conda-forge/<feedstock>
    • Fetch the latest updates with git fetch upstream
    • Pull in the latest changes into your main branch: git rebase upstream/main

  3. Creating your changes in a new branch

    Now you are ready to update the recipe

    • Create and switch to a new branch: git checkout -b <branch-name>. <branch-name> can be e.g. update_1_0_1.
    • Make your changes locally
    • Review your changes then use git add <changed-files>. Where <changed-files> are a whitespace separated list of filenames you changed.
    • Create a commit by git commit -m <commit-msg>, where <commit-msg> can be updated feedstock to version 1.0.1

  4. Pushing your changes to GitHub and propose a PR

    • Push the branch with changes to your fork on GitHub: git push origin <branch-name>
    • Create a pull request via the web interface by navigating to https://github.com/<your-github-id>/<feedstock> with your web browser and clicking the button create pull request.

Updating recipes​

Please follow the following guidelines while updating recipes:

  1. Always use a fork of the feedstock while updating the recipe.
  2. When a package's version is not changed, but other metadata or parts of the recipe are changed, increase the build number by 1.
  3. While shipping a new version of your package, reset the build number to 0.

Rerendering feedstocks​

Rerendering is conda-forge's way to update the files common to all feedstocks (e.g. README, CI configuration, pinned dependencies).

Rerendering can be done in two ways:

  1. Using the webservice to run conda-smithy on the cloud by adding the comment @conda-forge-admin please rerender (See Admin web services).
  2. Run conda-smithy locally on your machine (See Rerendering with conda-smithy locally).

Rerendering with conda-smithy locally​

The first step is to install conda-smithy in your root environment.

conda install -c conda-forge conda-smithy

Commit all changes and from the root directory of the feedstock, type:

conda smithy rerender -c auto

Optionally one can commit the changes manually. To do this drop -c auto from the command.

When to rerender​

We need to re-render when there are changes in the following parts of the feedstock:

  • Platform configuration (skip sections).
  • yum_requirements.txt or conda-forge.yml.
  • Updates in the build matrix due to new versions of Python, NumPy, PERL, R, etc.
  • Updates in conda-forge pinning that affect the feedstock.
  • Build issues that a feedstock configuration update will fix (follow us on Element to know about those).

Updating for newly released Python version​

When a new Python version is released (e.g. 3.11), an automatic migration process is triggered that will have @regro-cf-autotick-bot eventually automatically open pull requests to all feedstocks, updating their CI setup to include the new Python version in the build matrix. After veryfing that the PR build passes, that automatic PR can simply be merged to roll out packages for new Python version. This process takes time, though, and pull requests will not be opened to all feedstocks at the same time to not overload CI. The current status of the migration can be tracked on the migration status page and there maintainers can verify that their feedstock is listed under the AWAITING-PR dropdown list.

Testing changes locally​

If you have docker installed on your system, you can test builds locally on your machine under the same settings as it is built by our CI.

If you want to build and test updates to a feedstock locally, go to the root feedstock directory and run:

python build-locally.py

This will prompt you to choose one of the *.yaml config files in .ci_support/. Note that shyaml is needed to parse the docker_image from these files. Otherwise the build will use the default docker_image.

Alternatively, you can specify ahead which config to use with e.g. (assuming you wish to build and test python 3.6 on Linux, and such a config file exists at .ci_support/linux_python3.6.yaml):

python build-locally.py linux_python3.6

Note that for long build logs one can do

python build-locally.py 2>&1 | tee log.txt

to save it in a text file for future inspection.

Once built, you can find the finished package in the build_artifacts directory in your feedstock, which can be used as a channel.

To create a new environment my-new-env using conda, and which will contain the new built package my-package, run:

conda create -n my-new-env -c "file://${PWD}/build_artifacts" my-package

If the new built package depends on another one to be working, i.e. other-package, and which is available on conda-forge channel for example, you can run:

conda create -n my-new-env -c "file://${PWD}/build_artifacts" -c conda-forge my-package other-package

Downloading prebuilt packages from CI​

A neat feature that feedstocks have is the ability to upload packages to the CI provider for testing. This is useful when trying out packages built in a PR. But you first need to download these prebuilt packages.

To download prebuilt packages follow the steps below:

  • Starting from your PR, navigate to the CI.
  • Open the log corresponding to the package you want to download.
  • In this log find a link to the artifacts produced.
  • From the list of published artifacts that appears download your required archive.
  • Unarchive and extract the required package.

Removing broken packages​

Sometimes mistakes happen and a broken package ends up being uploaded to the conda-forge channel.

If the only issue is in the package metadata, we can directly patch it using the repo data patches feedstock. If this is the case, the following general guidelines should be followed:

  1. Update the feedstocks recipe to ensure future builds do not propagate the issue with a new build number.
  2. Please make a PR there to add a patch. The patch should specify as much has possible the versions and times when the packages were generated. It may use the following information
  • The current timestamp, you may generate it with python -c "import time; print(f'{time.time():.0f}000')".
  • The problematic version and build numbers of the packages to affect.

If instead the actual contents of the package are broken, the following steps will remove broken packages from the main channel:

  1. Locate the paths to broken files on anaconda.org, by searching for the conda-forge package and switching to the files tab.
  2. Fork conda-forge/admin-requests and add a new YML file in the requests directory.
  3. Add the broken files to the new YML document.See examples/example-broken.yml for an example file.
  4. Open a new PR. Once merged, a bot will label all listed files as broken, thus effectively removing them from the channel.

Archiving feedstocks​

If a package is no longer maintained conda-forge will archive the repository. An archived repository can no longer accept PRs and issues, which prevents people and regro-cf-autotick-bot from updating the package (an example would be to re-render the feedstock to support new Python versions). Note that this does not remove the existing packages, those will still be available.

If you believe a feedstock should be archived, please do the following:

  1. Raise an issue on the feedstock asking if it can be archived (CC the maintainer team and @conda-forge/core)
  2. Fork conda-forge/admin-requests and add a new text file in the archive directory with the repo name.
  3. Open a PR and cross-reference the issue raised in step 1.

Updating the maintainer list​

The list of maintainers of a feedstock is recorded in the recipe itself. A new maintainer can be added by opening an issue in the feedstock repository with the following title:

@conda-forge-admin, please add user @username

where username is the username of the new maintainer to be added. A PR will be automatically created and a maintainer or a member of the core team, in case no maintainer is active anymore, can then merge this PR to add the user. To contact core, ping them by mentioning @conda-forge/core in a comment or, if you haven't heard back in a while or are new to conda-forge, contact them through the community Element.

note

This PR is designed to skip building the package. Please do not modify it or adjust the commit message.

For an example see this issue.

Maintaining several versions​

If you'd like to maintain more than one version of your package, you can use branches on the feedstock. To do this:

  • Fork your feedstock and make a meaningful branch name (e.g., v1.X or v1.0).
  • Make the required changes to the recipe and rerender the feedstock.
  • Then push this branch from your fork to the upstream feedstock. Our CI services will automatically build any branches in addition to the default branch.