Skip to content

Commit 3a359b9

Browse files
committed
Merge pull request #232 from arschles/new-deisrel
doc(release-checklist): use new deisrel command format
2 parents 0d48686 + 4ef85cf commit 3a359b9

1 file changed

Lines changed: 4 additions & 13 deletions

File tree

src/roadmap/release-checklist.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -160,18 +160,10 @@ To generate changelogs, run the below command in each repository. Ensure that `$
160160
the previous tag that was generated in the repository.
161161

162162
```console
163-
$PREVIOUS_TAG=<previous release tag> make update-changelog # if make recipe exists (as in builder)
164-
_scripts/generate_changelog.sh $PREVIOUS_TAG # if make recipe doesn't exist (as in most repos)
163+
deisrel changelog individual $REPO_NAME $PREVIOUS_TAG $CURRENT_SHA $WORKFLOW_RELEASE
165164
```
166165

167-
This command will output the new changelog entry to STDOUT. Copy it and prepend it to the
168-
existing `CHANGELOG.md` file, and make sure to change `HEAD` in the header of the entry
169-
to `$WORKFLOW_RELEASE`.
170-
171-
Also copy the component changelog to a global release changelog, organized by component.
172-
This will only live on your local machine while doing the release. Once changelogs for all
173-
the components have been collected, publish the combined release notes as a gist so folks
174-
in Step 9 can start preparing supporting content for the release.
166+
This command will output the new changelog entry to STDOUT. Copy it and prepend it to the existing `CHANGELOG.md` file.
175167

176168
Finally, commit, push and submit a pull request for your changes:
177169

@@ -180,8 +172,7 @@ git commit CHANGELOG.md -m "doc(CHANGELOG.md): add entry for $WORKFLOW_RELEASE"
180172
git push -u $YOUR_FORK_REMOTE release-$WORKFLOW_RELEASE_SHORT
181173
```
182174

183-
Before you continue, ensure pull requests in all applicable repositories are reviewed, and merge
184-
them.
175+
Before you continue, ensure pull requests in all applicable repositories are reviewed, and merge them.
185176

186177
# Step 7: Tag and Push Git Repositories
187178

@@ -208,7 +199,7 @@ summary blog posts, tweets, notes for the monthly newsletter updates, etc.
208199
Provide a gist to the aggregated release notes. We can generate the aggregated changelog data from `deisrel`:
209200

210201
```console
211-
deisrel generate-changelog $PREVIOUS_TAG $WORKFLOW_RELEASE
202+
deisrel changelog global $PREVIOUS_TAG $WORKFLOW_RELEASE
212203
```
213204

214205
You are now done with the release.

0 commit comments

Comments
 (0)