mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
ff02d41721
Fixes #9581
191 lines
5.5 KiB
Go
191 lines
5.5 KiB
Go
// Copyright 2017-present The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// Package releaser implements a set of utilities and a wrapper around Goreleaser
|
|
// to help automate the Hugo release process.
|
|
package releaser
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"io"
|
|
"io/ioutil"
|
|
"net/http"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"text/template"
|
|
)
|
|
|
|
const (
|
|
issueLinkTemplate = "#%d"
|
|
linkTemplate = "[%s](%s)"
|
|
releaseNotesMarkdownTemplatePatchRelease = `
|
|
{{ if eq (len .All) 1 }}
|
|
This is a bug-fix release with one important fix.
|
|
{{ else }}
|
|
This is a bug-fix release with a couple of important fixes.
|
|
{{ end }}
|
|
{{ range .All }}
|
|
{{- if .GitHubCommit -}}
|
|
* {{ .Subject }} {{ .Hash }} {{ . | author }} {{ range .Issues }}{{ . | issue }} {{ end }}
|
|
{{ else -}}
|
|
* {{ .Subject }} {{ range .Issues }}{{ . | issue }} {{ end }}
|
|
{{ end -}}
|
|
{{- end }}
|
|
|
|
|
|
`
|
|
releaseNotesMarkdownTemplate = `
|
|
{{- $contribsPerAuthor := .All.ContribCountPerAuthor -}}
|
|
{{- $docsContribsPerAuthor := .Docs.ContribCountPerAuthor -}}
|
|
|
|
This release represents **{{ len .All }} contributions by {{ len $contribsPerAuthor }} contributors** to the main Hugo code base.
|
|
|
|
{{- if gt (len $contribsPerAuthor) 3 -}}
|
|
{{- $u1 := index $contribsPerAuthor 0 -}}
|
|
{{- $u2 := index $contribsPerAuthor 1 -}}
|
|
{{- $u3 := index $contribsPerAuthor 2 -}}
|
|
{{- $u4 := index $contribsPerAuthor 3 -}}
|
|
{{- $u1.AuthorLink }} leads the Hugo development with a significant amount of contributions, but also a big shoutout to {{ $u2.AuthorLink }}, {{ $u3.AuthorLink }}, and {{ $u4.AuthorLink }} for their ongoing contributions.
|
|
And thanks to [@digitalcraftsman](https://github.com/digitalcraftsman) for his ongoing work on keeping the themes site in pristine condition.
|
|
{{ end }}
|
|
Many have also been busy writing and fixing the documentation in [hugoDocs](https://github.com/gohugoio/hugoDocs),
|
|
which has received **{{ len .Docs }} contributions by {{ len $docsContribsPerAuthor }} contributors**.
|
|
{{- if gt (len $docsContribsPerAuthor) 3 -}}
|
|
{{- $u1 := index $docsContribsPerAuthor 0 -}}
|
|
{{- $u2 := index $docsContribsPerAuthor 1 -}}
|
|
{{- $u3 := index $docsContribsPerAuthor 2 -}}
|
|
{{- $u4 := index $docsContribsPerAuthor 3 }} A special thanks to {{ $u1.AuthorLink }}, {{ $u2.AuthorLink }}, {{ $u3.AuthorLink }}, and {{ $u4.AuthorLink }} for their work on the documentation site.
|
|
{{ end }}
|
|
|
|
Hugo now has:
|
|
|
|
{{ with .Repo -}}
|
|
* {{ .Stars }}+ [stars](https://github.com/gohugoio/hugo/stargazers)
|
|
* {{ len .Contributors }}+ [contributors](https://github.com/gohugoio/hugo/graphs/contributors)
|
|
{{- end -}}
|
|
{{ with .ThemeCount }}
|
|
* {{ . }}+ [themes](http://themes.gohugo.io/)
|
|
{{ end }}
|
|
{{ with .Notes }}
|
|
## Notes
|
|
{{ template "change-section" . }}
|
|
{{- end -}}
|
|
{{ with .All }}
|
|
## Changes
|
|
{{ template "change-section" . }}
|
|
{{ end }}
|
|
|
|
{{ define "change-section" }}
|
|
{{ range . }}
|
|
{{- if .GitHubCommit -}}
|
|
* {{ .Subject }} {{ .Hash }} {{ . | author }} {{ range .Issues }}{{ . | issue }} {{ end }}
|
|
{{ else -}}
|
|
* {{ .Subject }} {{ range .Issues }}{{ . | issue }} {{ end }}
|
|
{{ end -}}
|
|
{{- end }}
|
|
{{ end }}
|
|
`
|
|
)
|
|
|
|
var templateFuncs = template.FuncMap{
|
|
"isPatch": func(c changeLog) bool {
|
|
return !strings.HasSuffix(c.Version, "0")
|
|
},
|
|
"issue": func(id int) string {
|
|
return fmt.Sprintf(issueLinkTemplate, id)
|
|
},
|
|
"commitURL": func(info gitInfo) string {
|
|
if info.GitHubCommit.HTMLURL == "" {
|
|
return ""
|
|
}
|
|
return fmt.Sprintf(linkTemplate, info.Hash, info.GitHubCommit.HTMLURL)
|
|
},
|
|
"author": func(info gitInfo) string {
|
|
return "@" + info.GitHubCommit.Author.Login
|
|
},
|
|
}
|
|
|
|
func writeReleaseNotes(version string, infosMain, infosDocs gitInfos, to io.Writer) error {
|
|
client := newGitHubAPI("hugo")
|
|
changes := newChangeLog(infosMain, infosDocs)
|
|
changes.Version = version
|
|
repo, err := client.fetchRepo()
|
|
if err == nil {
|
|
changes.Repo = &repo
|
|
}
|
|
themeCount, err := fetchThemeCount()
|
|
if err == nil {
|
|
changes.ThemeCount = themeCount
|
|
}
|
|
|
|
mtempl := releaseNotesMarkdownTemplate
|
|
|
|
if !strings.HasSuffix(version, "0") {
|
|
mtempl = releaseNotesMarkdownTemplatePatchRelease
|
|
}
|
|
|
|
tmpl, err := template.New("").Funcs(templateFuncs).Parse(mtempl)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = tmpl.Execute(to, changes)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func fetchThemeCount() (int, error) {
|
|
resp, err := http.Get("https://raw.githubusercontent.com/gohugoio/hugoThemesSiteBuilder/main/themes.txt")
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
b, _ := ioutil.ReadAll(resp.Body)
|
|
return bytes.Count(b, []byte("\n")) - bytes.Count(b, []byte("#")), nil
|
|
}
|
|
|
|
func getReleaseNotesFilename(version string) string {
|
|
return filepath.FromSlash(fmt.Sprintf("temp/%s-relnotes-ready.md", version))
|
|
}
|
|
|
|
func (r *ReleaseHandler) writeReleaseNotesToTemp(version string, isPatch bool, infosMain, infosDocs gitInfos) (string, error) {
|
|
filename := getReleaseNotesFilename(version)
|
|
|
|
var w io.WriteCloser
|
|
|
|
if !r.try {
|
|
f, err := os.Create(filename)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
defer f.Close()
|
|
|
|
w = f
|
|
|
|
} else {
|
|
w = os.Stdout
|
|
}
|
|
|
|
if err := writeReleaseNotes(version, infosMain, infosDocs, w); err != nil {
|
|
return "", err
|
|
}
|
|
|
|
return filename, nil
|
|
}
|