Skip to content

broadinstitute/palantir-workflows

PALANTIR-WORKFLOWS

CircleCI

Utility workflows used by the DSP's Palantir team. This repository should be used to manage frequently used utility workflows for the team, and facilitate their use on Terra through Dockstore.

Remember, this is a public repository, so anything you put in this repo is publicly viewable.

Testing Workflows

All workflows should have associated tests. In order to add tests, you should add a test workflow to the test directory. The test workflow should call the workflow you are testing, and (preferably) compare the outputs to those expected. Input JSONs for the test workflow must be placed in a directory whose name is the same as the test workflow, with .wdl replaced by _json. So, the test directory structure will be built like this:

+-- palantir-workflows
|   +-- test
|   |   +-- MyWorkflow
|   |   |   +-- my_test_workflow.wdl
|   |   |   +-- my_test_workflow_json
|   |   |   |   +-- test_input_1.json
|   |   |   |   +-- test_input_2.json
+++++++++++++++++

Using the Dockstore Github App to Automatically Update Workflows in Dockstore/Terra

Workflows registered in Dockstore can be automatically synced when changes are pushed to this repo by adding their information to .dockstore.yml. In this way, a change pushed to a branch in this repo can be automatically propagated into any Terra workspaces using the workflow. Details can be found at Dockstore's Github App documentation.