biopet / sbt-bioconda   0.3.3

MIT License GitHub
Scala versions: 2.12
sbt plugins: 1.0

SBT-BIOCONDA

This plugin publishes scala or java tools on bioconda. It can be used to publish to other conda repositories as well. It automatically creates a recipe with a wrapper script. The wrapper script allows the command to be run with application instead of java -jar application.jar.

The recipes created are in concordance with bioconda's guidelines.

Installation

put

AddSbtPlugin("com.github.biopet","sbt-bioconda","0.3.2")

in your project/plugins.sbt file.

Requirements:

  • the Sbt Github release plugin must be used in your project. The repo authentication from this plugin is used. Also the bioconda plugin works very well in combination with this plugin.

  • An OAuth token is necessary to interact with the github repository and make the pull requests. This plugin requires an OAuth token with repo scope to interact with Github There are two ways to do this (as described on the Sbt Github release plugin project site):

    • Set GITHUB_TOKEN value in environment.
    • create a ~/.github properties file. Expected file format is: 
      oauth = 623454b0sd3645bdfdes541dd1fdg34504a8cXXX

  • the sbt git plugin must be used in your project. This plugin is used to clone the bioconda repository.

  • Docker must be installed on the system. And your user should be in the docker group on your system. (In other words: be able to run docker without sudo). Docker is used to test the recipes you create.

Usage

The following settingKeys are compulsory

biocondaGitUrl := "https://github.com/yourorganisation/bioconda-recipes" // your personal fork of bioconda-recipes

The following settingKeys can be used to tune the bioconda recipes to your liking:

name in Bioconda := "my_program" // Name of your tool on bioconda. 
// Defaults to normalizedName
biocondaVersion := "0.5" // The version of the tool. Defaults to version in Bioconda.
biocondaCommand := "my-program" // the command on the shell to execute your program. 
// Defaults to name in Bioconda
biocondaSummary := "summary" // A one sentence summary of your program.  
// Defaults to a generic description with a link to your homepage.
// Since this is a task you can set this to for example dynamically read your README.md if you want to.
biocondaDescription := "Description ..." // A longer description of your program if needed.
// defaults to None.
// Since this is a task you can set this to for example dynamically read your README.md if you want to.
homepage in Bioconda := "example.com" // The homepage of your project as displayed on bioconda. 
// Defaults to homepage of your project.
biocondaRequirements := Seq("openjdk") // The requirements for your project. 
// Defaults to Seq("openjdk")
biocondaBuildRequirements := Seq() // The build requirements for your project. 
// Defaults to Seq()
biocondaTestCommands := Seq("my-program --version", "my-program --test") 
// The commands that are used to test your recipe. Defaults to Seq()
biocondaDefaultJavaOptions: Seq() // You can use this to set the default memory options. 
// Default is empty.
biocondaOverwriteRecipes := false // You can use this if you want to overwrite previously published recipes.
// (Default: false)
biocondaPullRequestTitle := "my_program" // The title of the pull request on github.
biocondaPullRequestBody := " ... " // The pull request body. 
// Default is a text on the automated process of sbt-bioconda 
// and a summary of the tool taken from biocondaSummary.
biocondaLicense := "MIT" // The license you use. 
// By default checks your licenses key and takes one. Better to define this explicitly.

The following settingKeys can be used for more advanced settings. The defaults are designed for bioconda.

biocondaMainGitUrl := "https://github.com/bioconda/bioconda-recipes.git" 
// conda repository to which you want to pull.
biocondaMainBranch := "master" // The branch on which the stable recipes on the conda repository are defined.
biocondaNotes := " ... " // Notes on how to run the program this is compulsory for bioconda. 
// Default message explains the wrapper.
biocondaBuildNumber := 0 // The build number. T
// his defaults to zero. Change this if you published the same version twice. (This should never happen!)

The following settingKeys are for internal operation. You can change these at will.

biocondaBranch := "myprogram" // the branch on which your pull request is created. 
// Defaults to normalizedName in Bioconda
biocondaRepository := "/home/user/bioconda-recipes" // Where bioconda repository is located. 
// Will be created if not existing. Defaults to target.value/bioconda. 
biocondaRecipeDir := "recipes" // Where the recipes will be created.
// Defaults to target.value/recipes
biocondaCommitMessage := "Auto" // The default commit message.
// Default depends on value of biocondaNewTool. 
biocondaNewTool := true // Whether the tool is new in bioconda.
// This is automatically determined by the plugin, but you may use this key to override it.

Task keys:

  • biocondaUpdatedRepository makes sure a bioconda repository is present and up to date with bioconda main.
  • biocondaUpdatedBranch creates a branch for your tool that is up to date with bioconda main.
  • biocondaCreateRecipe creates the recipes for the current version of your tool.
  • biocondaCreateAllRecipes creates the recipes for all versions released on github, and not yet in bioconda. It checks which are already in bioconda main and only adds new ones. Unless biocondaOverwriteRecipes == true
  • biocondaAddRecipes adds the recipes to the local repository.
  • biocondaTestRecipes tests the newly added recipes.
  • biocondaPushRecipes pushes the local tool branch to your fork of bioconda.
  • biocondaPullRequest create a new pull request on bioconda main.
  • biocondaRelease Does all the steps necessary for a pull request for a release of the current version of your tool.
  • biocondaReleaseAll Does all the steps necessary for a pull request for all versions released on github and not yet in bioconda. If you do not want to publish all the recipes at once (default for biocondaReleaseAll) you can run the above commands manually and use the following keys:
  • biocondaCreateAllRecipes creates recipes for all versions released on github, and not yet in bioconda. You can manually delete some versions from target/recipes and then use biocondaAddRecipes, biocondaTestRecipes, biocondaPushRecipes and biocondaPullRequest to publish your selected versions.
  • biocondaCreateRecipe creates a recipe for the current version.

Known Issues

  • Versions with a - in .them crash on testing. This is a bioconda requirement If you released versions with a - the '-' will be removed from the version in the bioconda recipes.

Statistics

Contributors

5 Dependencies

No Dependent