Skip to content

Commit b59ea9e

Browse files
authored
WX-1611 Cromwell 87 release: streamline release WDL, documentation (#7422)
1 parent 9c6ec53 commit b59ea9e

File tree

5 files changed

+30
-433
lines changed

5 files changed

+30
-433
lines changed

processes/release_processes/README.MD

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,12 @@ See our "updating the process" [process](../README.MD)!
77

88
## Core Process: How to Publish and Release Cromwell
99

10-
Cromwell versions are updated on a weekly cadence automatically. For more information see [here](https://support.terra.bio/hc/en-us/articles/9512163608731-Faster-Cromwell-updates-in-Terra-)
10+
This process is unrelated to Terra. Both GCP and Azure Terra update automatically. For more information see [here](https://support.terra.bio/hc/en-us/articles/9512163608731-Faster-Cromwell-updates-in-Terra-).
1111

1212
Manually cutting a numeric release is expected to continue being done on a cadence of every ~6 months. If you're the lucky "Release Rotation Engineer" this time, you should do the following four things:
1313

14-
1. Create a Jira ticket for the release (look at previous release tickets if you're not sure how). In the Suggested
15-
Release Notes field, add "Terra is now running Cromwell <version>" along with any other release notes relevant to Terra
16-
users.
17-
1. Check that all most recent executions of Cromwell's Jenkins tests have succeeded, and that all those executions were
18-
against the most recent commit in "develop" branch. There are 2 groups of Jenkins tests which have to be checked (you
19-
will need to be on the Broad internal network or VPN to open the following links):
20-
1. Tests for various backends supported by Cromwell. Log into Jenkins [here](https://fc-jenkins.dsp-techops.broadinstitute.org), check the tests [here](https://fc-jenkins.dsp-techops.broadinstitute.org/job/cromwell-cron-parent/).
21-
1. Tests for Cromwell in Terra environment. Log into Jenkins [here](https://fc-jenkins.dsp-techops.broadinstitute.org), check the tests [here](https://fc-jenkins.dsp-techops.broadinstitute.org/view/Batch/).
14+
1. Create a Jira ticket for the release (look at previous release tickets if you're not sure how).
15+
1. Check that Cromwell's [nightly integration](https://github.com/broadinstitute/cromwell/actions?query=event%3Aschedule) testing is passing.
2216
1. [Run the publish script to create a new version of Cromwell](#how-to-publish-a-new-cromwell-version)
2317
1. [Run through the "How to Deploy Cromwell in CaaS prod" process](#how-to-deploy-cromwell-in-caas-staging-and-caas-prod)
2418

@@ -47,13 +41,10 @@ Make or copy the following files into a temporary `release/` directory outside t
4741

4842
* A copy of the workflow file to run (https://github.com/broadinstitute/cromwell/blob/develop/publish/publish_workflow.wdl)
4943
* An inputs json like this one.
50-
* `publishHomebrew` is `false` due to Homebrew taking on this part themselves. Homebrew remains an active distribution channel.
5144

5245
```json
5346
{
5447
"publish_workflow.githubToken": "<<GITHUB TOKEN VALUE>>",
55-
"publish_workflow.majorRelease": true,
56-
"publish_workflow.publishHomebrew": false,
5748
"publish_workflow.publishDocker": "broadinstitute/cromwell-publish:latest",
5849
"publish_workflow.organization": "broadinstitute"
5950
}
@@ -87,7 +78,7 @@ The workflow outputs its status to the console.
8778
* Check that the workflow succeeded.
8879
* Check that there's now a new Cromwell release listed [here](https://github.com/broadinstitute/cromwell/releases).
8980
* Let `#dsp-workflows-private` know that it's okay to resume merges to `develop`.
90-
* Announce release in `#dsp-workflows`, set expectations about when the new version will be available in Terra.
81+
* Announce release in `#dsp-workflows`, with context that it's for standalone Cromwells (the code is already in Terra).
9182
* **One business day later,** confirm that [the Homebrew package](https://formulae.brew.sh/formula/cromwell) has the latest version. If it doesn't, start investigation by looking at [Homebrew PR's](https://github.com/Homebrew/homebrew-core/pulls?q=is%3Apr+cromwell).
9283

9384
### Publish Docker Image
@@ -96,10 +87,11 @@ The workflow outputs its status to the console.
9687
* Run `sbt -Dproject.isSnapshot=false -Dproject.isRelease=true dockerBuildAndPush` from your local Cromwell directory.
9788
* Grab a cup of coffee, and verify that all of the new images were pushed successfully. For example, you should now be able to do `docker pull broadinstitute/cromwell:{new version #}`
9889
* The list of images is `cromwell`, `cromiam`, `cromwell-drs-localizer`, and `womtool`
90+
* Docker Hub links: [Cromwell](https://hub.docker.com/repository/docker/broadinstitute/cromwell/general), [CromIAM](https://hub.docker.com/repository/docker/broadinstitute/cromiam/general), [DRS Localizer](https://hub.docker.com/repository/docker/broadinstitute/cromwell-drs-localizer/general), [Womtool](https://hub.docker.com/repository/docker/broadinstitute/womtool/general)
9991

10092
### How to Deploy Cromwell in CaaS staging and CaaS prod
10193

102-
CaaS is "Cromwell as a Service". It is used by a couple of Broad teams (Pipelines and Epigenomics), though the long-term plan is for those teams to migrate to using Terra.
94+
CaaS is "Cromwell as a Service". It is only used by Epigenomics, and will eventually be retired in favor of Terra.
10395

10496
**Note:** If the Cromwell CHANGELOG indicates that the upgrade might take some time (e.g., because of a database migration), checking in with the CaaS users
10597
to let them know that the upgrade is about to happen is a good idea.
@@ -108,7 +100,7 @@ Deploying to CaaS is detailed in the [Quick CaaS Deployment Guide](https://docs.
108100

109101
### How to be Sure You're Done
110102

111-
Don't forget to confirm that [the Homebrew package](https://formulae.brew.sh/formula/cromwell) was updated!
103+
Confirm that [the Homebrew package](https://formulae.brew.sh/formula/cromwell) was updated.
112104

113105
## Bonus Processes
114106

processes/release_processes/firecloud-develop.dot

Lines changed: 0 additions & 77 deletions
This file was deleted.
Binary file not shown.

publish/publish_inputs.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
{
22
"publish_workflow.githubToken": "<<GITHUB TOKEN VALUE>>",
3-
"publish_workflow.majorRelease": true,
4-
"publish_workflow.publishHomebrew": false,
53
"publish_workflow.publishDocker": "broadinstitute/cromwell-publish:latest",
64
"publish_workflow.organization": "broadinstitute"
75
}

0 commit comments

Comments
 (0)