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

Reference conda and docker as installation methods. #5423

Merged
merged 5 commits into from
Feb 25, 2020

Conversation

rhpvorderman
Copy link
Collaborator

Both conda and docker are great for certain use cases. So it is of benefit that these are mentioned in the docs.

I removed "the preferred way is getting the jar" text because both the conda package and the docker container also contain the original jar. These are both way easier to use than a jar, so I would not recommend getting the jar over those two methods.

Both conda and docker are great for certain use cases. So it is of benefit that these are mentioned in the docs.
@cjllanwarne cjllanwarne added Community Contribution A pull request from the Cromwell open-source community Documentation labels Feb 21, 2020
Copy link
Contributor

@cjllanwarne cjllanwarne left a comment

Choose a reason for hiding this comment

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

Thanks! This looks great, just a few wording comments.

docs/Getting.md Outdated Show resolved Hide resolved
docs/Getting.md Outdated Show resolved Hide resolved
docs/Getting.md Outdated Show resolved Hide resolved
docs/Getting.md Outdated
You are strongly encouraged to use the latest release of Cromwell whenever possible.

Cromwell is distributed is a conda package on [conda-forge](https://conda-forge.org/).
Copy link
Contributor

Choose a reason for hiding this comment

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

OOI do you know who maintains the conda package for Cromwell? As someone who doesn't use conda, this seems like magic to me (and so I'm a little nervous about putting it in docs!)

If it's not automatic, could we say "Cromwell is also published with community support as a conda package ..."?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The cromwell feedstock maintainers. That includes me.
Our job is very easy though. Every time there is a new Cromwell release, the conda-forge autotick bot will update the recipe and ping us. We just have to check the recipe and click the merge button. We have not had a not-working PR from the autotick bot yet. Since there are four of us, the conda package is usually published within a day. Plus the conda version comes with a great wrapper.
As long as the Cromwell team keeps the naming scheme of the JARs the same, it should be fully automatic. If you want, you could be added as recipe maintainer.

rhpvorderman and others added 2 commits February 24, 2020 08:13
Co-Authored-By: Chris Llanwarne <cjllanwarne@users.noreply.github.com>
Copy link
Contributor

@cjllanwarne cjllanwarne left a comment

Choose a reason for hiding this comment

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

Looks good to me now, thanks for adding! One more thumb and it should be good to go.

@cjllanwarne cjllanwarne merged commit f2ccfce into broadinstitute:develop Feb 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community Contribution A pull request from the Cromwell open-source community Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants