Skip to content

Commit 42cb6e7

Browse files
authored
Merge pull request #12995 from sbueringer/pr-clarify-prev-release
🌱 release notes: clarify semantic of --previous-release-version
2 parents bf546f7 + caaa70c commit 42cb6e7

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

hack/tools/release/notes/main.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ func readCmdConfig() *notesCmdConfig {
7777
flag.StringVar(&config.toRef, "to", "", "The ref (tag, branch or commit to stop at. It must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If not set, it will default to branch.")
7878
flag.StringVar(&config.branch, "branch", "", "The branch to generate the notes from. If not set, it will be calculated from release.")
7979
flag.StringVar(&config.newTag, "release", "", "The tag for the new release.")
80-
flag.StringVar(&config.previousReleaseVersion, "previous-release-version", "", "The tag for the previous beta release.")
80+
flag.StringVar(&config.previousReleaseVersion, "previous-release-version", "", "The tag for the previous pre-release. This is used to generate an additional section with the changes since the previous pre-release"+
81+
"Accordingly this flag should not be set for the first pre-release.")
8182

8283
flag.BoolVar(&config.prefixAreaLabel, "prefix-area-label", true, "If enabled, will prefix the area label.")
8384
flag.BoolVar(&config.deprecation, "deprecation", true, "If enabled, will add a templated deprecation warning header.")

0 commit comments

Comments
 (0)