@@ -245,10 +245,34 @@ release is predetermined as the value of `$WORKFLOW_RELEASE`.
245245
246246### Step 7: Assemble Master Changelog
247247
248- Each component already updated its release notes on GitHub with CHANGELOG content. The
249- bodies of each component's release notes should be concatenated into a single gist. Note that there
250- may be more than one release per component--and more than one set of release notes--included in the
251- Workflow release.
248+ Each component already updated its release notes on GitHub with CHANGELOG content. We'll now
249+ generate the master changelog for the Workflow chart, consisting of all aforementioned component changes
250+ as well as those non-component repo changes needing to be manually added.
251+
252+ We'll employ the same ` generate_params.toml ` and ` components.json ` files as used in Step 4 above, this time
253+ invoking ` deisrel changelog global ` to get all component changes between the tag existing in the ` WORKFLOW_PREV_RELEASE `
254+ chart and the _ most recent_ release tag existing in GitHub. (Therefore, if there are any unreleased commits in
255+ a component repo, they will not appear here):
256+
257+ ``` bash
258+ deisrel changelog global $HOME /.helmc/workspace/charts/workflow-$WORKFLOW_PREV_RELEASE /tpl/generate_params.toml \
259+ components.json > $WORKFLOW_RELEASE
260+ ```
261+
262+ To get non-component repo changelogs (presumably tagged in Step 3 above), one can issue a command like the following
263+ which grabs the latest release body from GitHub:
264+
265+ ``` bash
266+ for repo in workflow workflow-cli workflow-e2e; do
267+ printf " $repo \n\n"
268+ printf " $( curl -s https://api.github.com/repos/deis/$repo /releases/latest | jq .body | sed ' s/"//g' ) \n\n"
269+ done
270+ ```
271+
272+ These can be added to the ` $WORKFLOW_RELEASE ` file created previously.
273+
274+ This master changelog should then be placed into a single gist. The file will also be added to the documentation
275+ update PR created in the next step.
252276
253277### Step 8: Update Documentation
254278
@@ -258,14 +282,11 @@ Use `git grep $WORKFLOW_PREV_RELEASE` to find any references, but be careful not
258282older releases to ` $WORKFLOW_PREV_RELEASE ` , so the documentation always describes upgrading
259283between recent versions.
260284
261- Create a new documentation page under the Changelogs section. The page should
262- be named after the release version, e.g. ` changelogs/v2.5.1 ` . The contents of
263- this page should be the consolidated changelog generated in Step 7. Makes sure
264- to edit or add a header to the page to make it clear that this is for a
265- Workflow release, e.g.:
285+ Place the ` $WORKFLOW_RELEASE ` master changelog generated in Step 7 in the ` changelogs ` directory.
286+ Make sure to add a header to the page to make it clear that this is for a Workflow release, e.g.:
266287
267288```
268- ## Workflow v2.4.x -> v2.5.1
289+ ## Workflow v2.7.0 -> v2.8.0
269290```
270291
271292### Step 9: Close GitHub Milestones
0 commit comments