Skip to content

Commit b0a601b

Browse files
author
Vaughn Dice
committed
docs(src/roadmap/release-checklist.md): adjust spacing
To fix the markdown representation of this doc.
1 parent 518b87b commit b0a601b

1 file changed

Lines changed: 49 additions & 51 deletions

File tree

src/roadmap/release-checklist.md

Lines changed: 49 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -38,72 +38,70 @@ be in a new directory called `workflow-rc1`.
3838

3939
# Step 1: Cut repo branches and push image tags
4040

41-
1. Once the release milestone is cleared of tickets in the workflow component repos, the release branches can be cut.
42-
43-
If only a particular repo is ready, navigate to said repo and:
44-
```
45-
git checkout master && git pull upstream master
46-
git checkout -b release-$WORKFLOW_RELEASE && git push upstream release-$WORKFLOW_RELEASE
47-
```
48-
Otherwise, for bulk-cutting all repos at the same time, we will use [sgoings/deis-workflow-group](https://github.com/sgoings/deis-workflow-group) here and in Step 2 below:
49-
```
50-
git clone git@github.com:sgoings/deis-workflow-group.git
51-
cd deis-workflow-group
52-
53-
make git-update # point all repos to latest master commits
54-
BRANCH="release-${WORKFLOW_RELEASE}" NEW="true" make git-checkout-branch
55-
BRANCH="release-${WORKFLOW_RELEASE}" make git-push-branch #(can use DRY_RUN=true)
56-
```
57-
58-
2. tag and push docker images to 'staging' `deisci` org
59-
```
60-
TAG="${WORKFLOW_RELEASE}" ORG="deisci" make docker-tag docker-push #(can use DRY_RUN=true)
61-
```
41+
1. Once the release milestone is cleared of tickets in the workflow component repos, the release branches can be cut.
42+
43+
If only a particular repo is ready, navigate to said repo and:
44+
45+
git checkout master && git pull upstream master
46+
git checkout -b release-$WORKFLOW_RELEASE && git push upstream release-$WORKFLOW_RELEASE
47+
48+
Otherwise, for bulk-cutting all repos at the same time, we will use [sgoings/deis-workflow-group](https://github.com/sgoings/deis-workflow-group) here and in Step 2 below:
49+
50+
git clone git@github.com:sgoings/deis-workflow-group.git
51+
cd deis-workflow-group
52+
53+
make git-update # point all repos to latest master commits
54+
BRANCH="release-${WORKFLOW_RELEASE}" NEW="true" make git-checkout-branch
55+
BRANCH="release-${WORKFLOW_RELEASE}" make git-push-branch #(can use DRY_RUN=true)
56+
57+
2. Tag and push docker images to 'staging' `deisci` org
58+
59+
TAG="${WORKFLOW_RELEASE}" ORG="deisci" make docker-tag docker-push #(can use DRY_RUN=true)
6260

6361
# Step 2: Create New Helm Classic Charts
6462

6563
Next, we'll create new [Helm Classic](https://github.com/helm/helm-classic) charts so that we can "stage" a
6664
version of our release for testing. Here is the current process to do so:
6765

68-
1. Create a new branch in [deis/charts](https://github.com/deis/charts): `git checkout -b release-$WORKFLOW_RELEASE upstream/master`
66+
1. Create a new branch in [deis/charts](https://github.com/deis/charts):
67+
68+
git checkout -b release-$WORKFLOW_RELEASE upstream/master
69+
70+
2. Download the [deisrel](https://github.com/deis/deisrel) binary via the bintray link provided in the project's README and place it in your `$PATH`
71+
72+
3. Copy the current `dev` charts into new `workflow-$WORKFLOW_RELEASE_SHORT` charts:
73+
74+
cp -r workflow-dev workflow-$WORKFLOW_RELEASE_SHORT
75+
cp -r workflow-dev-e2e workflow-$WORKFLOW_RELEASE_SHORT-e2e
76+
77+
4. Stage copies of all files needing release updates into the appropriate `workflow-$WORKFLOW_RELEASE_SHORT(-e2e)` chart directories:
78+
79+
deisrel helm-stage --tag $WORKFLOW_RELEASE --stagingDir workflow-$WORKFLOW_RELEASE_SHORT workflow
80+
deisrel helm-stage --tag $WORKFLOW_RELEASE --stagingDir workflow-$WORKFLOW_RELEASE_SHORT-e2e e2e
81+
82+
5. Delete the `KUBERNETES_POD_TERMINATION_GRACE_PERIOD_SECONDS` env var from `workflow-$WORKFLOW_RELEASE_SHORT/tpl/deis-controller-rc.yaml`
83+
84+
6. Test the chart and make sure it installs:
6985

70-
2. Download the [deisrel](https://github.com/deis/deisrel) binary via the bintray link provided in the project's README and place it in your `$PATH`
86+
cp -r workflow-$WORKFLOW_RELEASE_SHORT* `helmc home`/workspace/charts
87+
helmc generate workflow-$WORKFLOW_RELEASE_SHORT
88+
helmc install workflow-$WORKFLOW_RELEASE_SHORT
7189

72-
3. Copy the current `dev` charts into new `workflow-$WORKFLOW_RELEASE_SHORT` charts:
73-
```console
74-
cp -r workflow-dev workflow-$WORKFLOW_RELEASE_SHORT
75-
cp -r workflow-dev-e2e workflow-$WORKFLOW_RELEASE_SHORT-e2e
76-
```
90+
Optionally, run the e2e tests as well:
7791

78-
4. Stage copies of all files needing release updates into the appropriate `workflow-$WORKFLOW_RELEASE_SHORT(-e2e)` chart directories:
79-
```console
80-
deisrel helm-stage --tag $WORKFLOW_RELEASE --stagingDir workflow-$WORKFLOW_RELEASE_SHORT workflow
81-
deisrel helm-stage --tag $WORKFLOW_RELEASE --stagingDir workflow-$WORKFLOW_RELEASE_SHORT-e2e e2e
82-
```
92+
helmc generate workflow-$WORKFLOW_RELEASE_SHORT-e2e
93+
helmc install workflow-$WORKFLOW_RELEASE_SHORT-e2e
8394

84-
5. Delete the `KUBERNETES_POD_TERMINATION_GRACE_PERIOD_SECONDS` env var from `workflow-$WORKFLOW_RELEASE_SHORT/tpl/deis-controller-rc.yaml`
95+
7. Commit your changes:
8596

86-
6. Test the chart and make sure it installs:
87-
```console
88-
cp -r workflow-$WORKFLOW_RELEASE_SHORT* `helmc home`/workspace/charts
89-
helmc generate workflow-$WORKFLOW_RELEASE_SHORT
90-
helmc install workflow-$WORKFLOW_RELEASE_SHORT
91-
```
97+
git commit -a -m "chore(workflow-$WORKFLOW_RELEASE_SHORT): releasing workflow-$WORKFLOW_RELEASE_SHORT(-e2e)"
9298

93-
Optionally, run the e2e tests as well:
94-
```console
95-
helmc generate workflow-$WORKFLOW_RELEASE_SHORT-e2e
96-
helmc install workflow-$WORKFLOW_RELEASE_SHORT-e2e (to run the e2e tests)
97-
```
99+
8. Push your changes:
98100

99-
7. Commit your changes:
100-
```console
101-
git commit -a -m "chore(workflow-$WORKFLOW_RELEASE_SHORT): releasing workflow-$WORKFLOW_RELEASE_SHORT(-e2e)"
102-
```
101+
git push upstream HEAD:release-$WORKFLOW_RELEASE
103102

104-
8. Push your changes: `git push upstream HEAD:release-$WORKFLOW_RELEASE`.
105103

106-
9. Open a pull request from your branch to merge into `master` on https://github.com/deis/charts
104+
9. Open a pull request from your branch to merge into `master` on https://github.com/deis/charts
107105

108106
# Step 3: Kick off Jenkins Jobs
109107

0 commit comments

Comments
 (0)