cgeb2001's DokuWiki!

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

By Your Favourite Fake Biologist, Jason Shao (Last Edited: October 8th 2024)

In my never-ending plight, I only found out about [[https://ubinfie.github.io/2024/08/16/adding-to-bioconda-quickguide.html|this great blog post on the same topic]] shared by Finlay Maguire right after my own gruelling research. Anyways, thanks Fin! :)

Since the linked guide does a better job at explaining the basics than I could ever do, I will therefore only share **some useful hints and pitfalls to avoid**.

I wish you the best of luck in your quest!

====Source code is completed? Not so fast, write some CI checks!====
You will notice that I speak a lot about CI checks in this page, that's because passing the checks is what making a recipe is all about! Writing your own CI checks is a great way to learn about what they are and how they work, so it doesn't feel like a black box when you try to pass bioconda CI checks.\\

**P.S.** Ideally, you should write CI checks early in development to concretely define expected behaviour, also known as **Test-driven Development** (I will soon release a guide about CI checks and link it here).

====Source code is python only? Consider PyPi first!====
As you know, conda and PyPi are both package managers, with the distinction that PyPi is only for python packages. The advantage of conda is that it has multi-language support, which is very relevant for bioinformatics tools. However, if your source code is python only, then you should consider releasing on PyPi first to avoid unnecessary overheads and CI checks. Conda also makes it very simple to release PyPi packages as conda recipes (much simpler than from scratch).

====Source code is hosted on GitHub/GitLab? Generate a stable release (tar.gz)!====
With git, the HEAD of the main branch is updated every time you push a commit to it. Bioconda hates this, and for good reasons too -- it is very difficult to check for file integrity! Therefore, I strongly recommend generating a stable release instead, providing bioconda a tarball (tar.gz) of your source code and a hash with SHA256 for checksum. Both platforms offer intuitive workflow for generating a stable release, but the latter step is a bit more tricky. Follow these commands appropriate for your operating system:

**Linux**
<code>
$ sha256sum <Your Prefix>.tar.gz
</code>
**MacOS**
<code>
$ shasum -a 256 <Your Prefix>.tar.gz
</code>

However, the aforementioned two steps must be repeated for each time you make changes to your source code or your CI checks will fail, so it is very important to ensure your source code is truly ready beforehand.

====My program is for Linux only? Think again!====
Bioconda and their Apple fanboys insisted that every bioconda recipe must be available for both Linux and MacOS, so don't be blindsided by this, fellow Linux enjoyer!
Making your program more compatible entails adding appropriate binary executables and **tags** for MacOS. Follow this example **source** section of meta.yaml:
<code>
source:
  - url: <executable compatible to both platforms>.tar.gz
    sha256: <sha256 of url>
  - url: <MacOS executable>.tar.gz # [osx]
    sha256: <sha256 of url> # [osx]
  - url: <Linux executable>.tar.gz # [linux]
    sha256: <sha256 of url> # [linux]
</code>

====After an eternity, my checks are all passing...====
Congratulations, champion of Considerable Grit, you are almost at the end! Make sure to make a comment to get your pull request ready to be reviewed!
<code>
@BiocondaBot please add label
</code>
Once assigned, the reviewer may go through several rounds of suggested revisions. Feel free to follow-up on suggested changes that you don't fully understand! 
====Wow, it's really now merged!====
Now you'll have to maintain it, nyeheheheheh! {{https://media1.tenor.com/m/AOhlRdeaSfgAAAAC/heman-smile.gif?100}}

Please fill all the letters into the box to prove you're human. Y T K M C Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International