/
tmpl.go
260 lines (232 loc) · 6.78 KB
/
tmpl.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
// Package tmpl provides templating utilities for goreleaser.
package tmpl
import (
"bytes"
"fmt"
"path/filepath"
"regexp"
"strings"
"text/template"
"time"
"github.com/Masterminds/semver/v3"
"github.com/goreleaser/goreleaser/internal/artifact"
"github.com/goreleaser/goreleaser/pkg/build"
"github.com/goreleaser/goreleaser/pkg/context"
)
// Template holds data that can be applied to a template string.
type Template struct {
fields Fields
}
// Fields that will be available to the template engine.
type Fields map[string]interface{}
const (
// general keys.
projectName = "ProjectName"
version = "Version"
rawVersion = "RawVersion"
tag = "Tag"
previousTag = "PreviousTag"
branch = "Branch"
commit = "Commit"
shortCommit = "ShortCommit"
fullCommit = "FullCommit"
commitDate = "CommitDate"
commitTimestamp = "CommitTimestamp"
gitURL = "GitURL"
summary = "Summary"
tagSubject = "TagSubject"
tagContents = "TagContents"
releaseURL = "ReleaseURL"
major = "Major"
minor = "Minor"
patch = "Patch"
prerelease = "Prerelease"
isSnapshot = "IsSnapshot"
env = "Env"
date = "Date"
timestamp = "Timestamp"
modulePath = "ModulePath"
releaseNotes = "ReleaseNotes"
runtimeK = "Runtime"
// artifact-only keys.
osKey = "Os"
arch = "Arch"
arm = "Arm"
mips = "Mips"
binary = "Binary"
artifactName = "ArtifactName"
artifactPath = "ArtifactPath"
// build keys.
name = "Name"
ext = "Ext"
path = "Path"
target = "Target"
)
// New Template.
func New(ctx *context.Context) *Template {
sv := ctx.Semver
rawVersionV := fmt.Sprintf("%d.%d.%d", sv.Major, sv.Minor, sv.Patch)
return &Template{
fields: Fields{
projectName: ctx.Config.ProjectName,
modulePath: ctx.ModulePath,
version: ctx.Version,
rawVersion: rawVersionV,
tag: ctx.Git.CurrentTag,
previousTag: ctx.Git.PreviousTag,
branch: ctx.Git.Branch,
commit: ctx.Git.Commit,
shortCommit: ctx.Git.ShortCommit,
fullCommit: ctx.Git.FullCommit,
commitDate: ctx.Git.CommitDate.UTC().Format(time.RFC3339),
commitTimestamp: ctx.Git.CommitDate.UTC().Unix(),
gitURL: ctx.Git.URL,
summary: ctx.Git.Summary,
tagSubject: ctx.Git.TagSubject,
tagContents: ctx.Git.TagContents,
releaseURL: ctx.ReleaseURL,
env: ctx.Env,
date: ctx.Date.UTC().Format(time.RFC3339),
timestamp: ctx.Date.UTC().Unix(),
major: ctx.Semver.Major,
minor: ctx.Semver.Minor,
patch: ctx.Semver.Patch,
prerelease: ctx.Semver.Prerelease,
isSnapshot: ctx.Snapshot,
releaseNotes: ctx.ReleaseNotes,
runtimeK: ctx.Runtime,
},
}
}
// WithEnvS overrides template's env field with the given KEY=VALUE list of
// environment variables.
func (t *Template) WithEnvS(envs []string) *Template {
result := map[string]string{}
for _, env := range envs {
parts := strings.SplitN(env, "=", 2)
result[parts[0]] = parts[1]
}
return t.WithEnv(result)
}
// WithEnv overrides template's env field with the given environment map.
func (t *Template) WithEnv(e map[string]string) *Template {
t.fields[env] = e
return t
}
// WithExtraFields allows to add new more custom fields to the template.
// It will override fields with the same name.
func (t *Template) WithExtraFields(f Fields) *Template {
for k, v := range f {
t.fields[k] = v
}
return t
}
// WithArtifact populates Fields from the artifact and replacements.
func (t *Template) WithArtifact(a *artifact.Artifact, replacements map[string]string) *Template {
bin := a.Extra[binary]
if bin == nil {
bin = t.fields[projectName]
}
t.fields[osKey] = replace(replacements, a.Goos)
t.fields[arch] = replace(replacements, a.Goarch)
t.fields[arm] = replace(replacements, a.Goarm)
t.fields[mips] = replace(replacements, a.Gomips)
t.fields[binary] = bin.(string)
t.fields[artifactName] = a.Name
t.fields[artifactPath] = a.Path
return t
}
func (t *Template) WithBuildOptions(opts build.Options) *Template {
return t.WithExtraFields(buildOptsToFields(opts))
}
func buildOptsToFields(opts build.Options) Fields {
return Fields{
target: opts.Target,
ext: opts.Ext,
name: opts.Name,
path: opts.Path,
osKey: opts.Goos,
arch: opts.Goarch,
arm: opts.Goarm,
mips: opts.Gomips,
}
}
// Apply applies the given string against the Fields stored in the template.
func (t *Template) Apply(s string) (string, error) {
var out bytes.Buffer
tmpl, err := template.New("tmpl").
Option("missingkey=error").
Funcs(template.FuncMap{
"replace": strings.ReplaceAll,
"time": func(s string) string {
return time.Now().UTC().Format(s)
},
"tolower": strings.ToLower,
"toupper": strings.ToUpper,
"trim": strings.TrimSpace,
"trimprefix": strings.TrimPrefix,
"trimsuffix": strings.TrimSuffix,
"dir": filepath.Dir,
"abs": filepath.Abs,
"incmajor": incMajor,
"incminor": incMinor,
"incpatch": incPatch,
}).
Parse(s)
if err != nil {
return "", err
}
err = tmpl.Execute(&out, t.fields)
return out.String(), err
}
type ExpectedSingleEnvErr struct{}
func (e ExpectedSingleEnvErr) Error() string {
return "expected {{ .Env.VAR_NAME }} only (no plain-text or other interpolation)"
}
// ApplySingleEnvOnly enforces template to only contain a single environment variable
// and nothing else.
func (t *Template) ApplySingleEnvOnly(s string) (string, error) {
s = strings.TrimSpace(s)
if len(s) == 0 {
return "", nil
}
// text/template/parse (lexer) could be used here too,
// but regexp reduces the complexity and should be sufficient,
// given the context is mostly discouraging users from bad practice
// of hard-coded credentials, rather than catch all possible cases
envOnlyRe := regexp.MustCompile(`^{{\s*\.Env\.[^.\s}]+\s*}}$`)
if !envOnlyRe.Match([]byte(s)) {
return "", ExpectedSingleEnvErr{}
}
var out bytes.Buffer
tmpl, err := template.New("tmpl").
Option("missingkey=error").
Parse(s)
if err != nil {
return "", err
}
err = tmpl.Execute(&out, t.fields)
return out.String(), err
}
func replace(replacements map[string]string, original string) string {
result := replacements[original]
if result == "" {
return original
}
return result
}
func incMajor(v string) string {
return prefix(v) + semver.MustParse(v).IncMajor().String()
}
func incMinor(v string) string {
return prefix(v) + semver.MustParse(v).IncMinor().String()
}
func incPatch(v string) string {
return prefix(v) + semver.MustParse(v).IncPatch().String()
}
func prefix(v string) string {
if v != "" && v[0] == 'v' {
return "v"
}
return ""
}