Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions source/contributor/guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -783,3 +783,29 @@ a distribution mechanism for packages, so it is not appropriate for software
development work on a package (like supporting an additional platform) to be
exclusivly performed in the Bioconda repo. It's important to engage the
upstream authors on such efforts if at all possible.

Updating multiple software major versions simultaneously
----------------------------------------------------------

In some cases, a particular software package may support updates and patches for
two major versions of a tool at the same time.
For example, a developer continues relasing fixes to v2.x series, even if most
development continues on a v3.x series.

To continue to support releases of both versions of a tool within a Bioconda
recipe, use the main recipe `meta.yaml` for the more recent major version,
and place the older version in a subdirectory with it's own `meta.yaml`.

An example of this is the `mitos
<https://github.com/bioconda/bioconda-recipes/tree/c2b7cbc80054a309e8fc3c91f9efed4e642e447d/recipes/mitos>`_ package.

.. code-block:: yaml

recipes/mitos
├── meta.yaml
└── mitos1
└── meta.yaml

The original `mitos` v1 recipe is under the `mitos1/` directory, but the
`meta.yaml` for the more recent v2 file is in a dedicated sub directory.