Skip to content

Commit bf11ea7

Browse files
author
Vaughn Dice
committed
docs(src/roadmap/releases.md): update master changelog step
Ref deis/deisrel#146
1 parent 3b5069d commit bf11ea7

1 file changed

Lines changed: 31 additions & 10 deletions

File tree

src/roadmap/releases.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -235,10 +235,34 @@ release is predetermined as the value of `$WORKFLOW_RELEASE`.
235235

236236
### Step 7: Assemble Master Changelog
237237

238-
Each component already updated its release notes on GitHub with CHANGELOG content. The
239-
bodies of each component's release notes should be concatenated into a single gist. Note that there
240-
may be more than one release per component--and more than one set of release notes--included in the
241-
Workflow release.
238+
Each component already updated its release notes on GitHub with CHANGELOG content. We'll now
239+
generate the master changelog for the Workflow chart, consisting of all aforementioned component changes
240+
as well as those non-component repo changes needing to be manually added.
241+
242+
We'll employ the same `generate_params.toml` and `components.json` files as used in Step 4 above, this time
243+
invoking `deisrel changelog global` to get all component changes between the tag existing in the `WORKFLOW_PREV_RELEASE`
244+
chart and the _most recent_ release tag existing in GitHub. (Therefore, if there are any unreleased commits in
245+
a component repo, they will not appear here):
246+
247+
```bash
248+
deisrel changelog global $HOME/.helmc/workspace/charts/workflow-$WORKFLOW_PREV_RELEASE/tpl/generate_params.toml \
249+
components.json > $WORKFLOW_RELEASE
250+
```
251+
252+
To get non-component repo changelogs (presumably tagged in Step 3 above), one can issue a command like the following
253+
which grabs the latest release body from GitHub:
254+
255+
```bash
256+
for repo in workflow workflow-cli workflow-e2e; do
257+
printf "$repo\n\n"
258+
printf "$(curl -s https://api.github.com/repos/deis/$repo/releases/latest | jq .body | sed 's/"//g')\n\n"
259+
done
260+
```
261+
262+
These can be added to the `$WORKFLOW_RELEASE` file created previously.
263+
264+
This master changelog should then be placed into a single gist. The file will also be added to the documentation
265+
update PR created in the next step.
242266

243267
### Step 8: Update Documentation
244268

@@ -248,14 +272,11 @@ Use `git grep $WORKFLOW_PREV_RELEASE` to find any references, but be careful not
248272
older releases to `$WORKFLOW_PREV_RELEASE`, so the documentation always describes upgrading
249273
between recent versions.
250274

251-
Create a new documentation page under the Changelogs section. The page should
252-
be named after the release version, e.g. `changelogs/v2.5.1`. The contents of
253-
this page should be the consolidated changelog generated in Step 7. Makes sure
254-
to edit or add a header to the page to make it clear that this is for a
255-
Workflow release, e.g.:
275+
Place the `$WORKFLOW_RELEASE` master changelog generated in Step 7 in the `changelogs` directory.
276+
Make sure to add a header to the page to make it clear that this is for a Workflow release, e.g.:
256277

257278
```
258-
## Workflow v2.4.x -> v2.5.1
279+
## Workflow v2.7.0 -> v2.8.0
259280
```
260281

261282
### Step 9: Close GitHub Milestones

0 commit comments

Comments
 (0)