Skip to content

Commit e6d36a6

Browse files
author
Vaughn Dice
authored
docs(src/roadmap/releases.md): simplify docs in global changelog step (#722)
Ref deis/deisrel#157
1 parent b7ee6df commit e6d36a6

1 file changed

Lines changed: 4 additions & 18 deletions

File tree

src/roadmap/releases.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ number.
169169

170170
To create and stage a release candidate chart for Workflow, we will build the [workflow-chart-stage](https://ci.deis.io/job/workflow-chart-stage) job with the following parameters:
171171

172-
`CHART_REPO_TYPE=staging` and `RELEASE_TAG=$WORKFLOW_RELEASE`
172+
`RELEASE_TAG=$WORKFLOW_RELEASE`
173173

174174
This job will gather all of the latest component release tags and use these to specify the versions of all component charts.
175175
It will then package the Workflow chart, upload it to the staging chart repo and kick off an e2e run against said chart.
@@ -202,32 +202,18 @@ it if it has not done so already.
202202
### Step 6: Assemble Master Changelog
203203

204204
Each component already updated its release notes on GitHub with CHANGELOG content. We'll now
205-
generate the master changelog for the Workflow chart, consisting of all aforementioned component changes
206-
as well as those non-component repo changes needing to be manually added.
205+
generate the master changelog for the Workflow chart, consisting of all component and auxilliary repo changes.
207206

208-
We'll employ the `requirements.lock` file from the `WORKFLOW_PREV_RELEASE` chart, as well as a repo-to-chart-name mapping file
209-
(see [here](https://github.com/deis/deisrel/blob/master/README.md#usage) for an example), this time invoking `deisrel changelog global` to get all component changes between
207+
We'll employ the `requirements.lock` file from the `WORKFLOW_PREV_RELEASE` chart, as well as a repo-to-chart-name [mapping file](https://github.com/deis/deisrel/blob/master/map.json), this time invoking `deisrel changelog global` to get all component changes between
210208
the chart versions existing in the `WORKFLOW_PREV_RELEASE` chart and the _most recent_ releases existing in GitHub.
211209
(Therefore, if there are any unreleased commits in a component repo, they will not appear here):
212210

213211
```bash
214212
helm repo add deis https://charts.deis.com/workflow
215213
helm fetch --untar deis/workflow --version $WORKFLOW_PREV_RELEASE
216-
deisrel changelog global workflow/requirements.lock mapping.json > changelog-$WORKFLOW_RELEASE.md
217-
```
218-
219-
To get non-component repo changelogs (presumably tagged in Step 3 above), one can issue a command like the following
220-
which grabs the latest release body from GitHub:
221-
222-
```bash
223-
for repo in workflow workflow-cli workflow-e2e; do
224-
printf "$repo\n\n"
225-
printf "$(curl -s https://api.github.com/repos/deis/$repo/releases/latest | jq .body | sed 's/"//g')\n\n"
226-
done
214+
deisrel changelog global workflow/requirements.lock map.json > changelog-$WORKFLOW_RELEASE.md
227215
```
228216

229-
These can be added to the `$WORKFLOW_RELEASE` file created previously.
230-
231217
This master changelog should then be placed into a single gist. The file will also be added to the documentation
232218
update PR created in the next step.
233219

0 commit comments

Comments
 (0)