Skip to content

Commit e84fb14

Browse files
committed
docs(releases): tag workflow-* repositories
1 parent 69875ef commit e84fb14

1 file changed

Lines changed: 19 additions & 8 deletions

File tree

src/roadmap/releases.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,16 @@ git commit -a -m "chore(workflow-$WORKFLOW_RELEASE): update WORKFLOW_RELEASE"
126126
git push upstream HEAD:master
127127
```
128128

129-
### Step 3: Create Helm Charts
129+
### Step 3: Tag Supporting Repositories
130+
131+
Some Workflow components not in the Helm chart must also be tagged in sync with the release.
132+
Follow the [component release process](#how-to-release-a-component) above and ensure that
133+
these components are tagged:
134+
- [deis/workflow][]
135+
- [deis/workflow-cli][]
136+
- [deis/workflow-e2e][]
137+
138+
### Step 4: Create Helm Charts
130139

131140
For a patch release, check out the previous tag and cherry-pick commits onto it:
132141

@@ -193,7 +202,7 @@ git push origin HEAD:release-$WORKFLOW_RELEASE
193202

194203
Open a pull request at [deis/charts][] to merge this branch into master.
195204

196-
### Step 4: Manual Testing
205+
### Step 5: Manual Testing
197206

198207
Now it's time to go above and beyond current CI tests. Create a testing matrix spreadsheet (copying
199208
from the previous document is a good start) and sign up testers to cover all permutations.
@@ -210,7 +219,7 @@ When showstopper-level bugs are found, the process is as follows:
210219
1. Update that component's `dockerTag` value in the release chart(s) to the new semver tag
211220
1. Commit and push the chart changes to the release branch and restart testing
212221

213-
### Step 5: Merge and Put CHANGELOG in GitHub Release Notes
222+
### Step 6: Merge and Put CHANGELOG in GitHub Release Notes
214223

215224
When testing has completed without uncovering any new showstopper bugs and the charts PR has been
216225
reviewed successfully, merge it to master. Then update your local master branch, tag it with the
@@ -231,27 +240,27 @@ deisrel changelog individual workflow $WORKFLOW_PREV_RELEASE HEAD $WORKFLOW_RELE
231240
open https://github.com/deis/workflow/releases/new?tag=$WORKFLOW_RELEASE
232241
```
233242

234-
### Step 6: Close GitHub Milestone
243+
### Step 7: Close GitHub Milestone
235244

236245
Close the GitHub milestone for [deis/charts][] and for [deis/workflow][] and create new ones for
237246
the next planned release.
238247

239-
### Step 7: Update Documentation
248+
### Step 8: Update Documentation
240249

241250
Create a new pull request at [deis/workflow][] that updates version references to the new release.
242251
Use `git grep $WORKFLOW_PREV_RELEASE` to find any references, but be careful not to change
243252
`CHANGELOG.md`. This PR should also change `upgrading-workflow-md` by updating references to
244253
older releases to `$WORKFLOW_PREV_RELEASE`, so the documentation always describes upgrading
245254
between recent versions.
246255

247-
### Step 8: Assemble Master Changelog
256+
### Step 9: Assemble Master Changelog
248257

249258
Each component already updated its release notes on GitHub with CHANGELOG content. The
250259
bodies of each component's release notes should be concatenated into a single gist. Note that there
251260
may be more than one release per component--and more than one set of release notes--included in the
252261
Workflow release.
253262

254-
### Step 9: Close GitHub Milestones
263+
### Step 10: Close GitHub Milestones
255264

256265
Create a pull request at [seed-repo](https://github.com/deis/seed-repo) to close the release
257266
milestone and create the next one. When changes are merged to seed-repo, milestones on all
@@ -261,7 +270,7 @@ to the next upcoming milestone before merging the pull request.
261270
Milestones map to Deis Workflow releases in [deis/charts][]. These milestones do not correspond
262271
to individual component release tags.
263272

264-
### Step 10: Let Everyone Know
273+
### Step 11: Let Everyone Know
265274

266275
Let the rest of the team know they can start blogging and tweeting about the new Workflow release.
267276
Post a message to the #company channel on Slack. Include a link to the released chart and to the
@@ -278,5 +287,7 @@ You're done with the release. Nice job!
278287
[continuous delivery]: https://en.wikipedia.org/wiki/Continuous_delivery
279288
[deis/charts]: https://github.com/deis/charts
280289
[deis/workflow]: https://github.com/deis/workflow
290+
[deis/workflow-cli]: https://github.com/deis/workflow-cli
291+
[deis/workflow-e2e]: https://github.com/deis/workflow-e2e
281292
[Helm classic]: https://github.com/helm/helm-classic
282293
[semantic version]: http://semver.org

0 commit comments

Comments
 (0)