Skip to content

Commit a0ff462

Browse files
committed
doc(release-checklist): Improve instructions pertaining to previous release
1 parent a92ce02 commit a0ff462

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

src/roadmap/release-checklist.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@ This document describes how to release a new Workflow version. It's targeted tow
44
maintainers.
55

66
The below sections present a step-by-step guide to publish a new Workflow release. Throughout all
7-
of the examples, we'll be assuming that the below two environment variables are present in wherever
7+
of the examples, we'll be assuming that the below four environment variables are present wherever
88
you're working. Make sure to set them (e.g. by `export`ing them) before you get started.
99

10-
- `$WORKFLOW_RELEASE` - the full name of this version. For example, `v2.0.0-rc2` for a minor version, `v2.0.0` for a major version.
11-
- `$WORKFLOW_RELEASE_SHORT` - The short name of this version. For example, `rc2` for a minor version and identical to `$WORKFLOW_RELEASE` above if a major version.
10+
- `$WORKFLOW_RELEASE` - the full name of this version. For example, `v2.0.0-rc2` for a pre-release version or `v2.0.0` otherwise.
11+
- `$WORKFLOW_RELEASE_SHORT` - The short name of this version. For example, `rc2` for a pre-release version or identical to `$WORKFLOW_RELEASE` above otherwise.
12+
- `$WORKFLOW_PREV_RELEASE` - the full name of the previous version. For example, `v2.0.0-rc1` for a pre-release version or `v2.0.0` otherwise.
13+
- `$WORKFLOW_PREV_RELEASE_SHORT` - The short name of the previous version. For example, `rc1` for a pre-release version or identical to `$WORKFLOW_PREV_RELEASE` above otherwise.
1214

1315
# What's a Release?
1416

@@ -116,11 +118,12 @@ values used in job above.
116118
# Step 4: Update Documentation
117119

118120
Create a new pull request against deis/workflow, updating all references of the old release to
119-
`$WORKFLOW_RELEASE`. Use `git grep $WORKFLOW_OLD_RELEASE` to find any references. (Be careful not to
120-
change `CHANGELOG.md`)
121+
`$WORKFLOW_RELEASE`. Use `git grep $WORKFLOW_PREV_RELEASE` and `git grep
122+
$WORKFLOW_PREV_RELEASE_SHORT` to find any references. (Be careful not to change `CHANGELOG.md`)
121123

122-
Also, note there may be an occurrence of the previous oldest release (prior to `$WORKFLOW_OLD_RELEASE`) in
123-
`upgrading-workflow.md`. This should be changed to `$WORKFLOW_OLD_RELEASE`.
124+
Also, note there may be occurrences of an older release (prior to
125+
`$WORKFLOW_PREV_RELEASE`) in `upgrading-workflow.md`. These should be changed to
126+
`$WORKFLOW_PREV_RELEASE`.
124127

125128
# Step 5: Manual Testing
126129

0 commit comments

Comments
 (0)