Skip to content

Commit c774d6f

Browse files
authored
Merge pull request #381 from mboersma/update-release-checklist
docs(release-checklist): update release dance
2 parents 72f3dc6 + 52d15b9 commit c774d6f

1 file changed

Lines changed: 7 additions & 18 deletions

File tree

src/roadmap/release-checklist.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ A release consists of the following artifacts:
2525
- [minio](https://github.com/deis/minio)
2626
- [monitor](https://github.com/deis/monitor)
2727
- [postgres](https://github.com/deis/postgres)
28+
- [redis](https://github.com/deis/redis)
2829
- [registry](https://github.com/deis/registry)
2930
- [router](https://github.com/deis/router)
3031
- [slugbuilder](https://github.com/deis/slugbuilder)
3132
- [slugrunner](https://github.com/deis/slugrunner)
32-
- [stdout-metrics](https://github.com/deis/stdout-metrics)
3333
- [workflow](https://github.com/deis/workflow)
3434
- [workflow-e2e](https://github.com/deis/workflow-e2e)
3535
- [workflow-manager](https://github.com/deis/workflow-manager)
@@ -91,7 +91,7 @@ We'll need to update the `WORKFLOW_RELEASE` value used by all relevant Jenkins j
9191
Next, we'll create new [Helm Classic](https://github.com/helm/helm-classic) charts so that we can "stage" a
9292
version of our release for testing. Here is the current process to do so:
9393

94-
1. Checkout the `release-$WORKFLOW_RELEASE` branch in [deis/charts](https://github.com/deis/charts) (created in Step 1.1 above):
94+
1. Checkout the `release-$WORKFLOW_RELEASE` branch in [deis/charts](https://github.com/deis/charts) (created in Step 2.2 above):
9595

9696
git fetch upstream
9797
git checkout release-$WORKFLOW_RELEASE
@@ -172,7 +172,7 @@ Amazon S3 |
172172
- update the appropriate component's `dockerTag` value in the release chart with the `git-<issue_fix_sha>` as deployed above.
173173
- push updated chart change(s) to existing release branch and re-convene testing
174174

175-
When testing shows no further issues and the release chart is ready to ship, make sure the pull request is reviewed once more and merged before continuing.
175+
The pull request should **not** be merged yet--it will be updated with SemVer-tagged docker images in the next step.
176176

177177
!!! note
178178

@@ -189,6 +189,8 @@ To do so, simply run the following `deisrel` command:
189189
deisrel docker retag $WORKFLOW_RELEASE --new-org="deis -ref release-$WORKFLOW_RELEASE"
190190
```
191191

192+
Update the PR by replacing all `dockerTag` values with the `$WORKFLOW_RELEASE` tag. Make sure the pull request is reviewed once more and merged before continuing.
193+
192194
# Step 8: Update Changelogs
193195

194196
At this point, part of the first part and all of the second part of the release is complete.
@@ -197,29 +199,16 @@ components are done.
197199

198200
The remaining work is simply generating changelogs and tagging each component's GitHub repository.
199201

200-
First, create a branch for the new changelog:
201-
202-
```console
203-
git checkout -b release-$WORKFLOW_RELEASE_SHORT
204-
```
205-
206202
To generate changelogs, run the below command in each repository. Ensure that `$PREVIOUS_TAG` is
207203
the previous tag that was generated in the repository.
208204

209205
```console
210206
deisrel changelog individual $REPO_NAME $PREVIOUS_TAG $CURRENT_SHA $WORKFLOW_RELEASE
211207
```
212208

213-
This command will output the new changelog entry to STDOUT. Copy it and prepend it to the existing `CHANGELOG.md` file.
214-
215-
Finally, commit, push and submit a pull request for your changes:
216-
217-
```console
218-
git commit CHANGELOG.md -m "doc(CHANGELOG.md): add entry for $WORKFLOW_RELEASE"
219-
git push -u $YOUR_FORK_REMOTE release-$WORKFLOW_RELEASE_SHORT
220-
```
209+
This command will output the new changelog entry to STDOUT. Copy it and paste into the GitHub release notes section for the release tag.
221210

222-
Before you continue, ensure pull requests in all applicable repositories are reviewed, and merge them.
211+
Repeat these steps to create the changelog content for every Workflow component's release notes.
223212

224213
# Step 9: Tag and Push Git Repositories
225214

0 commit comments

Comments
 (0)