Skip to content

Commit d18dec4

Browse files
committed
chore(changelog): update release process for new changelog page
1 parent 0d43482 commit d18dec4

1 file changed

Lines changed: 16 additions & 6 deletions

File tree

src/roadmap/releases.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -246,20 +246,30 @@ deisrel changelog individual workflow $WORKFLOW_PREV_RELEASE HEAD $WORKFLOW_RELE
246246
open https://github.com/deis/workflow/releases/new?tag=$WORKFLOW_RELEASE
247247
```
248248

249-
### Step 7: Update Documentation
249+
### Step 7: Assemble Master Changelog
250+
251+
Each component already updated its release notes on GitHub with CHANGELOG content. The
252+
bodies of each component's release notes should be concatenated into a single gist. Note that there
253+
may be more than one release per component--and more than one set of release notes--included in the
254+
Workflow release.
255+
256+
### Step 8: Update Documentation
250257

251258
Create a new pull request at [deis/workflow][] that updates version references to the new release.
252259
Use `git grep $WORKFLOW_PREV_RELEASE` to find any references, but be careful not to change
253260
`CHANGELOG.md`. This PR should also change `upgrading-workflow-md` by updating references to
254261
older releases to `$WORKFLOW_PREV_RELEASE`, so the documentation always describes upgrading
255262
between recent versions.
256263

257-
### Step 8: Assemble Master Changelog
264+
Create a new documentation page under the Changelogs section. The page should
265+
be named after the release version, e.g. `changelogs/v2.5.1`. The contents of
266+
this page should be the consolidated changelog generated in Step 7. Makes sure
267+
to edit or add a header to the page to make it clear that this is for a
268+
Workflow release, e.g.:
258269

259-
Each component already updated its release notes on GitHub with CHANGELOG content. The
260-
bodies of each component's release notes should be concatenated into a single gist. Note that there
261-
may be more than one release per component--and more than one set of release notes--included in the
262-
Workflow release.
270+
```
271+
## Workflow v2.4.x -> v2.5.1
272+
```
263273

264274
### Step 9: Close GitHub Milestones
265275

0 commit comments

Comments
 (0)