Skip to content

Commit ef3193c

Browse files
author
Aaron Schlesinger
committed
doc(releasing.md): completing remaining release steps
1 parent c33839b commit ef3193c

1 file changed

Lines changed: 47 additions & 5 deletions

File tree

src/contributing/releasing.md

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,17 +99,59 @@ TAG=$DEIS_RELEASE make docker-tag
9999
make docker-push
100100
```
101101

102-
# Step 5: Update Changelogs
102+
# Step 5: Update Helm chart
103103

104-
TODO
104+
Now that new Docker images are on public Docker repositories, it's time to update the Helm chart
105+
to reference the official images. To do so, simply modify all `dockerTag` entries in the
106+
`generate_params.toml` files in the `workflow-$DEIS_RELEASE_SHORT` and
107+
`workflow-$DEIS_RELEASE_SHORT-e2e` to be `$DEIS_RELEASE` (instead of the ones based on git tags).
105108

106-
Update changelogs for each repository
109+
When you're done, commit and push your changes. You should get your pull request reviewed and
110+
merged before continuing.
107111

108-
# Step 6: Tag and push git repos
112+
# Step 6: Update Changelogs
109113

110-
Inside the deis-workflow-group directory, run:
114+
At this point, part of the first part and all of the second part of the release is complete.
115+
That is, the Helm chart for the new Deis version is done, and new Docker versions for all
116+
components are done.
117+
118+
The remaining work is simply generating changelogs and tagging each component's GitHub repository.
119+
120+
First, create a branch for the new changelog:
121+
122+
```console
123+
git checkout -b release-$DEIS_RELEASE_SHORT
124+
```
125+
126+
To generate changelogs, run the below command in each repository. Ensure that `$PREVIOUS_TAG` is
127+
the previous tag that was generated in the repository.
128+
129+
```console
130+
_scripts/generate_changelog.sh $PREVIOUS_TAG
131+
```
132+
133+
This command will output the new changelog entry to STDOUT. Copy it and prepend it to the
134+
existing `CHANGELOG.md` file, and make sure to change `HEAD` in the header of the entry
135+
to `$DEIS_RELEASE`.
136+
137+
Finally, commit, push and submit a Pull Request for your changes:
138+
139+
```console
140+
git commit CHANGELOG.md -m "doc(CHANGELOG.md): add entry for $DEIS_RELEASE_SHORT"
141+
git push -u $YOUR_FORK_REMOTE $DEIS_RELEASE_SHORT
142+
```
143+
144+
Before you continue, ensure pull requests in all applicable repositories are reviewed, and merge
145+
them.
146+
147+
# Step 7: Tag and push git repos
148+
149+
The final step of the release process is to tag each git repository, and push the tag to each
150+
GitHub project. To do so, simply run the below command in the `deis-workflow-group` repository:
111151

112152
```console
113153
TAG=$DEIS_RELEASE TAG_MESSAGE="releasing workflow $DEIS_RELEASE" make git-tag
114154
make git-tag-push
115155
```
156+
157+
You are now done with the release

0 commit comments

Comments
 (0)