releaser: Create a proper automated title for patch releases
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Tue, 30 Jul 2019 07:02:03 +0000 (09:02 +0200)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Tue, 30 Jul 2019 07:02:03 +0000 (09:02 +0200)
Fixes #6126

releaser/releasenotes_writer.go
releaser/releaser.go

index 146cee198ff95d822a65f8d74e1b77195245daf3..82bcc629b1ce4cee48a06063c97f00a13d02430c 100644 (file)
@@ -272,7 +272,7 @@ func (r *ReleaseHandler) writeReleaseNotesToTemp(version string, isPatch bool, i
 
 }
 
-func (r *ReleaseHandler) writeReleaseNotesToDocs(title, sourceFilename string) (string, error) {
+func (r *ReleaseHandler) writeReleaseNotesToDocs(title, description, sourceFilename string) (string, error) {
        targetFilename := "index.md"
        bundleDir := strings.TrimSuffix(filepath.Base(sourceFilename), "-ready.md")
        contentDir := hugoFilepath("docs/content/en/news/" + bundleDir)
@@ -315,7 +315,7 @@ description: %q
 categories: ["Releases"]%s
 ---
 
-       `, time.Now().Format("2006-01-02"), title, title, fmTail)); err != nil {
+       `, time.Now().Format("2006-01-02"), title, description, fmTail)); err != nil {
                return "", err
        }
 
index 178ad02a66270fdcc98304ec555b698e31954459..61b9d211ffecff0c926c7c604904fe6cfcbbc2eb 100644 (file)
@@ -95,6 +95,8 @@ func (r *ReleaseHandler) Run() error {
        version := newVersion.String()
        tag := "v" + version
        isPatch := newVersion.PatchLevel > 0
+       mainVersion := newVersion
+       mainVersion.PatchLevel = 0
 
        // Exit early if tag already exists
        exists, err := tagExists(tag)
@@ -193,8 +195,14 @@ func (r *ReleaseHandler) Run() error {
 
        releaseNotesFile := getReleaseNotesDocsTempFilename(version, true)
 
+       title, description := version, version
+       if isPatch {
+               title = "Hugo " + version + ": A couple of Bug Fixes"
+               description = "This version fixes a couple of bugs introduced in " + mainVersion.String() + "."
+       }
+
        // Write the release notes to the docs site as well.
-       docFile, err := r.writeReleaseNotesToDocs(version, releaseNotesFile)
+       docFile, err := r.writeReleaseNotesToDocs(title, description, releaseNotesFile)
        if err != nil {
                return err
        }