broadinstitute / palantir-workflows

Utility workflows for the DSP hydro.gen team (formerly palantir)
BSD 3-Clause "New" or "Revised" License
19 stars 8 forks source link

PALANTIR-WORKFLOWS

Test Status

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

Automated WDL testing is implemented using watt. To add tests, update test/watt_config.yml. See the watt documentation for usage details. Tests are run using github actions, controlled by .github/workflows/run_tests.yaml. Automated testing also validates all WDLs found in the repository, regardless of whether tests have been added for the particular WDL, using womtool validate. Automated testing is performed on all PR's, as well as any pushes to the main branch.

During testing, WDLs are run on GCP, with the execution bucket gs://palantir-workflows-test-execution. Generally, input and expected output files are stored in gs://palantir-workflows-test-data. The stdout from watt will be visible in the github actions UI, and cromwell log files can be found in a zipped artifact named cromwell_logs, also in the github actions UI.

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.