Skip to content

Commit bd2b10a

Browse files
author
Matthew Fisher
committed
feat(roadmap): add step to update docs
1 parent feaa148 commit bd2b10a

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

src/roadmap/release-checklist.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,12 @@ Navigate to https://ci.deis.io/job/workflow-test-release/ and kick off a new job
6666

6767
As of this writing, the e2e tests in this job are run on a GKE cluster using default (minio) external storage.
6868

69-
# Step 3: Manual Testing
69+
# Step 3: Update Documentation
70+
71+
Create a new pull request against deis/workflow, updating all references of the old release to
72+
`$WORKFLOW_RELEASE`. Use `git grep $WORKFLOW_OLD_RELEASE` to find any references.
73+
74+
# Step 4: Manual Testing
7075

7176
After the chart is created with the immutable Docker image tags that represent the final images
7277
(i.e. the ones that will be re-tagged to the immutable release tag, such as `2.0.0-beta4`), it
@@ -90,7 +95,7 @@ Amazon S3 |
9095
- Update the appropriate docker tag(s) in the `generate_params.toml` file
9196
- Push this change to the release branch
9297

93-
# Step 4: Tag and Push Docker Images
98+
# Step 5: Tag and Push Docker Images
9499

95100
After everyone has tested and determined that there are no show-stopping problems for this release,
96101
it's time to tag each individual Docker image with `$WORKFLOW_RELEASE`.
@@ -103,7 +108,7 @@ make git-update
103108
TAG=$WORKFLOW_RELEASE make docker-tag docker-push
104109
```
105110

106-
# Step 5: Update Helm Classic Chart
111+
# Step 6: Update Helm Classic Chart
107112

108113
Now that new Docker images are on public Docker repositories, it's time to update the Helm Classic chart
109114
to reference the official images. We will use `deisrel` to do this. The following will change every `dockerTag` value
@@ -126,7 +131,7 @@ When you're done, commit and push your changes. You should get your pull request
126131

127132
**Note:** If non-release-specific amendments have been made to the release chart that do not exist in the `workflow-dev`, be sure to PR said changes for this chart as well.
128133

129-
# Step 6: Update Changelogs
134+
# Step 7: Update Changelogs
130135

131136
At this point, part of the first part and all of the second part of the release is complete.
132137
That is, the Helm Classic chart for the new Workflow version is done, and new Docker versions for all
@@ -158,7 +163,7 @@ git push -u $YOUR_FORK_REMOTE release-$WORKFLOW_RELEASE_SHORT
158163

159164
Before you continue, ensure pull requests in all applicable repositories are reviewed, and merge them.
160165

161-
# Step 7: Tag and Push Git Repositories
166+
# Step 8: Tag and Push Git Repositories
162167

163168
The final step of the release process is to tag each git repository, and push the tag to each
164169
GitHub project. To do so, simply run the below command in the `deisrel` repository:
@@ -167,14 +172,14 @@ GitHub project. To do so, simply run the below command in the `deisrel` reposito
167172
deisrel git tag $WORKFLOW_RELEASE
168173
```
169174

170-
# Step 8: Close GitHub Milestones
175+
# Step 9: Close GitHub Milestones
171176

172177
Close the github milestone by creating a new pull request at
173178
[seed-repo](https://github.com/deis/seed-repo). Any changes merged to master on that repository
174179
will be applied to all of the component projects. If there are open issues attached to the
175180
milestone, move them to the next upcoming milestone before merging the pull request.
176181

177-
# Step 9: Let Everyone Know
182+
# Step 10: Let Everyone Know
178183

179184
Jump in #company on slack and let folks know that the release has been cut! This will let
180185
folks in supporting functions know that they should start the release support process including

0 commit comments

Comments
 (0)