Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 'how to add a bioconda recipe and biocontainer' tutorial #39

Merged
merged 11 commits into from
Sep 11, 2024

Conversation

jfy133
Copy link
Contributor

@jfy133 jfy133 commented Aug 17, 2024

Opening this already so people can shame me into finishing it (will be slow going for a while because baby).

I'm basically cleaning up these notes: https://hackmd.io/@jfy133/ryXNpa9Op

At the end I'll make a fast TL;DR version too probably

@jfy133 jfy133 requested a review from a team as a code owner August 17, 2024 19:57
@jfy133 jfy133 marked this pull request as draft August 19, 2024 09:45
@jfy133 jfy133 marked this pull request as ready for review August 27, 2024 11:31
@jfy133 jfy133 requested a review from a team as a code owner August 27, 2024 11:31
@jfy133 jfy133 changed the title [WIP] Add 'how to add a bioconda recipe and biocontainer' tutorial Add 'how to add a bioconda recipe and biocontainer' tutorial Aug 28, 2024
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When rendering the website, the background is still not white. I don't know if that can be fixed in the markup here or it would be easier to add a white background to the original graphic.
grafik

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I follow, the image is a SVG, and there is no background - and the background of the iamge in your sceenshot still looks seamless with the background of the blog, e.g. if I open in my image viewer...

image

Do you mean in the main boxes (one time setup, for each tool) etc?

Copy link

@samuell samuell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here mostly just commenting on some typos and language fixes.

_posts/2024-08-14-adding-to-bioconda-quickguide.md Outdated Show resolved Hide resolved
_posts/2024-08-14-adding-to-bioconda-quickguide.md Outdated Show resolved Hide resolved
_posts/2024-08-14-adding-to-bioconda-quickguide.md Outdated Show resolved Hide resolved
@Wytamma
Copy link

Wytamma commented Aug 28, 2024

Fantastic work @jfy133! I successfully submitted pango-collapse to Bioconda 🎉

I've add a few minor comments/suggestions. Only major gripe would be that it's very long and I feel like I didn't need it all i.e. I was adding a package from PYPI so most of the R/build.sh steps were irrelevant. I'm not sure if there's a way to break this up into package types? e.g. only show some sections if they are applicable. (the TLDR is good tho)

_posts/2024-08-14-adding-to-bioconda-quickguide.md Outdated Show resolved Hide resolved
_posts/2024-08-14-adding-to-bioconda-quickguide.md Outdated Show resolved Hide resolved
_posts/2024-08-14-adding-to-bioconda-quickguide.md Outdated Show resolved Hide resolved

```bash
cd recipes/
greyskull <pypi/cran> > <toolname>/meta.yaml
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
greyskull <pypi/cran> > <toolname>/meta.yaml
greyskull <pypi/cran> <toolname> > <toolname>/meta.yaml

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

greyskull pypi: error: the following arguments are required: pypi_packages

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also once I ran greyskull it added a bunch of \u0000 values to the end of the meta.yaml file which then failed linting.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting... I also don't get the 'following arguments' error, not \u000 with the new command I will be pushing... maybe you can try that

_posts/2024-08-14-adding-to-bioconda-quickguide.md Outdated Show resolved Hide resolved
_posts/2024-08-14-adding-to-bioconda-quickguide.md Outdated Show resolved Hide resolved
_posts/2024-08-14-adding-to-bioconda-quickguide.md Outdated Show resolved Hide resolved
@jfy133
Copy link
Contributor Author

jfy133 commented Aug 29, 2024

Fantastic work @jfy133! I successfully submitted pango-collapse to Bioconda 🎉

I've add a few minor comments/suggestions. Only major gripe would be that it's very long and I feel like I didn't need it all i.e. I was adding a package from PYPI so most of the R/build.sh steps were irrelevant. I'm not sure if there's a way to break this up into package types? e.g. only show some sections if they are applicable. (the TLDR is good tho)

Woohoo thank you!

Addressed all the minor comments :)

Indeed, I did wonder if it would make sense to split it up into three posts: adding a recipe, debugging, and updating, what do you think?

I see what you mean about the build.sh steps not being relevant, but I don't think there is sufficient difference between the types for it to make sense (there is basically python/(some) R, and everything else)...

I guess I could see if the <details> HTML works for teh build.sh step... and hide all of that section. Would that help? Taht said it's the debugging section that is the longest...

@jfy133
Copy link
Contributor Author

jfy133 commented Aug 29, 2024

Unfortunately the <details> trick didn't work as the markdown formatting gets lost :(

I'm erring on keeping build.sh though as it's actually very common outside of Python. Still happy to consider moving the debugging section into a separate post.

Copy link
Contributor

@pmenzel pmenzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's time to merge it!

@jfy133 jfy133 requested review from samuell and Wytamma September 10, 2024 14:31
@pmenzel pmenzel merged commit ac802db into ubinfie:main Sep 11, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants