Skip to content

Commit 272a8af

Browse files
committed
docs(releases): paste CHANGELOG into tag annotation
1 parent 4b5ba11 commit 272a8af

1 file changed

Lines changed: 17 additions & 11 deletions

File tree

src/roadmap/releases.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,21 @@ export NEW_RELEASE=v2.2.1 # changelog agrees it's a patch release
7272

7373
### Step 2: Push the Release Tag
7474

75-
Push the new release tag to the GitHub repository:
75+
Generate the CHANGELOG with the [`deisrel`](https://github.com/deis/deisrel.git) tool and paste
76+
it into an annotation on the new release tag. Edit out any unnecessary blank lines. Then push the
77+
new release tag to the GitHub repository:
7678

7779
```bash
78-
git tag $NEW_RELEASE && git push upstream $NEW_RELEASE
80+
deisrel changelog individual $COMPONENT $OLD_RELEASE $NEW_SHA $NEW_RELEASE | pbcopy
81+
git tag -a $NEW_RELEASE # paste the CHANGELOG into your editor and save
82+
git push upstream $NEW_RELEASE
7983
```
8084

8185
### Step 3: Put CHANGELOG in GitHub Release Notes
8286

83-
Generate the CHANGELOG with the [`deisrel`](https://github.com/deis/deisrel.git) tool and paste
84-
it into the body of release notes for the component in GitHub. In the "Release Title" field, use
85-
the project & component with its release, such as "Deis Controller v2.2.1":
87+
Paste the same CHANGELOG from the previous step into the body of release notes for the component
88+
in GitHub. In the "Release Title" field, use the project & component with its release, such as
89+
"Deis Controller v2.2.1":
8690

8791
```bash
8892
deisrel changelog individual $COMPONENT $OLD_RELEASE $NEW_SHA $NEW_RELEASE | pbcopy
@@ -213,18 +217,20 @@ When showstopper-level bugs are found, the process is as follows:
213217
### Step 5: Merge and Put CHANGELOG in GitHub Release Notes
214218

215219
When testing has completed without uncovering any new showstopper bugs and the charts PR has been
216-
reviewed successfully, merge it to master. Then update your local master branch, tag it with the
217-
release, and push the tag:
220+
reviewed successfully, merge it to master. Then update your local master branch and generate the
221+
CHANGELOG with the [`deisrel`](https://github.com/deis/deisrel.git) tool. Paste that content into
222+
an annotation on the new release tag, then push the tag:
218223

219224
```bash
220225
git checkout master && git fetch --tags upstream master && git merge upstream/master
221-
git tag $WORKFLOW_RELEASE
226+
deisrel changelog individual workflow $WORKFLOW_PREV_RELEASE HEAD $WORKFLOW_RELEASE | pbcopy
227+
git tag -a $WORKFLOW_RELEASE # paste the CHANGELOG into your editor and save
222228
git push upstream $WORKFLOW_RELEASE
223229
```
224230

225-
Generate the CHANGELOG with the [`deisrel`](https://github.com/deis/deisrel.git) tool and paste
226-
it into the body of release notes for [deis/charts][] in GitHub. In the "Release Title" field, use
227-
the project & component with its release, such as "Deis Workflow v2.3.0":
231+
Paste the same CHANGELOG from the previous step into the body of release notes for [deis/charts][]
232+
in GitHub. In the "Release Title" field, use the project & component with its release, such as
233+
"Deis Workflow v2.3.0":
228234

229235
```bash
230236
deisrel changelog individual workflow $WORKFLOW_PREV_RELEASE HEAD $WORKFLOW_RELEASE | pbcopy

0 commit comments

Comments
 (0)