forked from release-drafter/release-drafter
/
releases.js
327 lines (281 loc) · 9.09 KB
/
releases.js
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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
const compareVersions = require('compare-versions')
const regexEscape = require('escape-string-regexp')
const { getVersionInfo } = require('./versions')
const { template } = require('./template')
const log = require('./log')
const sortReleases = (releases) => {
// For semver, we find the greatest release number
// For non-semver, we use the most recently merged
try {
return releases.sort((r1, r2) => compareVersions(r1.tag_name, r2.tag_name))
} catch (error) {
return releases.sort(
(r1, r2) => new Date(r1.created_at) - new Date(r2.created_at)
)
}
}
module.exports.findReleases = async ({ app, context }) => {
let releases = await context.github.paginate(
context.github.repos.listReleases.endpoint.merge(
context.repo({
per_page: 100,
})
)
)
log({ app, context, message: `Found ${releases.length} releases` })
const sortedPublishedReleases = sortReleases(releases.filter((r) => !r.draft))
const draftRelease = releases.find((r) => r.draft)
const lastRelease =
sortedPublishedReleases[sortedPublishedReleases.length - 1]
if (draftRelease) {
log({ app, context, message: `Draft release: ${draftRelease.tag_name}` })
} else {
log({ app, context, message: `No draft release found` })
}
if (lastRelease) {
log({ app, context, message: `Last release: ${lastRelease.tag_name}` })
} else {
log({ app, context, message: `No last release found` })
}
return { draftRelease, lastRelease }
}
const contributorsSentence = ({ commits, pullRequests }) => {
const contributors = new Set()
commits.forEach((commit) => {
if (commit.author.user) {
contributors.add(`@${commit.author.user.login}`)
} else {
contributors.add(commit.author.name)
}
})
pullRequests.forEach((pullRequest) => {
if (pullRequest.author) {
contributors.add(`@${pullRequest.author.login}`)
}
})
const sortedContributors = Array.from(contributors).sort()
if (sortedContributors.length > 1) {
return (
sortedContributors.slice(0, sortedContributors.length - 1).join(', ') +
' and ' +
sortedContributors.slice(-1)
)
} else {
return sortedContributors[0]
}
}
const getFilterExcludedPullRequests = (excludeLabels) => {
return (pullRequest) => {
const labels = pullRequest.labels.nodes
if (labels.some((label) => excludeLabels.includes(label.name))) {
return false
}
return true
}
}
const getFilterIncludedPullRequests = (includeLabels) => {
return (pullRequest) => {
const labels = pullRequest.labels.nodes
if (
includeLabels.length == 0 ||
labels.some((label) => includeLabels.includes(label.name))
) {
return true
}
return false
}
}
const categorizePullRequests = (pullRequests, config) => {
const {
'exclude-labels': excludeLabels,
'include-labels': includeLabels,
categories,
} = config
const allCategoryLabels = categories.flatMap((category) => category.labels)
const uncategorizedPullRequests = []
const categorizedPullRequests = [...categories].map((category) => {
return { ...category, pullRequests: [] }
})
const filterUncategorizedPullRequests = (pullRequest) => {
const labels = pullRequest.labels.nodes
if (
labels.length === 0 ||
!labels.some((label) => allCategoryLabels.includes(label.name))
) {
uncategorizedPullRequests.push(pullRequest)
return false
}
return true
}
// we only want pull requests that have yet to be categorized
const filteredPullRequests = pullRequests
.filter(getFilterExcludedPullRequests(excludeLabels))
.filter(getFilterIncludedPullRequests(includeLabels))
.filter(filterUncategorizedPullRequests)
categorizedPullRequests.map((category) => {
filteredPullRequests.map((pullRequest) => {
// lets categorize some pull request based on labels
// note that having the same label in multiple categories
// then it is intended to "duplicate" the pull request into each category
const labels = pullRequest.labels.nodes
if (labels.some((label) => category.labels.includes(label.name))) {
category.pullRequests.push(pullRequest)
}
})
})
return [uncategorizedPullRequests, categorizedPullRequests]
}
const generateChangeLog = (mergedPullRequests, config) => {
if (mergedPullRequests.length === 0) {
return config['no-changes-template']
}
const [
uncategorizedPullRequests,
categorizedPullRequests,
] = categorizePullRequests(mergedPullRequests, config)
const escapeTitle = (title) =>
// If config['change-title-escapes'] contains backticks, then they will be escaped along with content contained inside backticks
// If not, the entire backtick block is matched so that it will become a markdown code block without escaping any of its content
title.replace(new RegExp(`[${regexEscape(config['change-title-escapes'])}]|\`.*?\``, 'g'), (match) =>
match.length > 1 ? match
: match == '@' || match == '#' ? `${match}<!---->` : `\\${match}`)
const pullRequestToString = (pullRequests) =>
pullRequests
.map((pullRequest) =>
template(config['change-template'], {
$TITLE: escapeTitle(pullRequest.title),
$NUMBER: pullRequest.number,
$AUTHOR: pullRequest.author ? pullRequest.author.login : 'ghost',
$BODY: pullRequest.body,
$URL: pullRequest.url,
})
)
.join('\n')
const changeLog = []
if (uncategorizedPullRequests.length) {
changeLog.push(pullRequestToString(uncategorizedPullRequests))
changeLog.push('\n\n')
}
categorizedPullRequests.map((category, index) => {
if (category.pullRequests.length) {
changeLog.push(`## ${category.title}\n\n`)
changeLog.push(pullRequestToString(category.pullRequests))
if (index + 1 !== categorizedPullRequests.length) changeLog.push('\n\n')
}
})
return changeLog.join('').trim()
}
const resolveVersionKeyIncrement = (mergedPullRequests, config) => {
const priorityMap = {
patch: 1,
minor: 2,
major: 3,
}
const labelToKeyMap = Object.fromEntries(
Object.keys(priorityMap)
.flatMap((key) => [
config['version-resolver'][key].labels.map((label) => [label, key]),
])
.flat()
)
const keys = mergedPullRequests
.filter(getFilterExcludedPullRequests(config['exclude-labels']))
.filter(getFilterIncludedPullRequests(config['include-labels']))
.flatMap((pr) => pr.labels.nodes.map((node) => labelToKeyMap[node.name]))
.filter(Boolean)
const keyPriorities = keys.map((key) => priorityMap[key])
const priority = Math.max(...keyPriorities)
const versionKey = Object.keys(priorityMap).find(
(key) => priorityMap[key] === priority
)
return versionKey || config['version-resolver'].default
}
module.exports.generateChangeLog = generateChangeLog
module.exports.generateReleaseInfo = ({
commits,
config,
lastRelease,
mergedPullRequests,
version = undefined,
tag = undefined,
name = undefined,
isPreRelease,
shouldDraft,
}) => {
let body = config.template
body = template(
body,
{
$PREVIOUS_TAG: lastRelease ? lastRelease.tag_name : '',
$CHANGES: generateChangeLog(mergedPullRequests, config),
$CONTRIBUTORS: contributorsSentence({
commits,
pullRequests: mergedPullRequests,
}),
},
config.replacers
)
const versionInfo = getVersionInfo(
lastRelease,
config['version-template'],
// Use the first override parameter to identify
// a version, from the most accurate to the least
version || tag || name,
resolveVersionKeyIncrement(mergedPullRequests, config)
)
if (versionInfo) {
body = template(body, versionInfo)
}
if (tag === undefined) {
tag = versionInfo ? template(config['tag-template'] || '', versionInfo) : ''
}
if (name === undefined) {
name = versionInfo
? template(config['name-template'] || '', versionInfo)
: ''
}
return {
name,
tag,
body,
prerelease: isPreRelease,
draft: shouldDraft,
}
}
module.exports.createRelease = ({ context, releaseInfo }) => {
return context.github.repos.createRelease(
context.repo({
name: releaseInfo.name,
tag_name: releaseInfo.tag,
body: releaseInfo.body,
draft: releaseInfo.draft,
prerelease: releaseInfo.prerelease,
})
)
}
module.exports.updateRelease = ({ context, draftRelease, releaseInfo }) => {
const updateReleaseParams = updateDraftReleaseParams({
name: releaseInfo.name || draftRelease.name,
tag_name: releaseInfo.tag || draftRelease.tag_name,
})
return context.github.repos.updateRelease(
context.repo({
release_id: draftRelease.id,
body: releaseInfo.body,
draft: releaseInfo.draft,
prerelease: releaseInfo.prerelease,
...updateReleaseParams,
})
)
}
function updateDraftReleaseParams(params) {
const updateReleaseParams = { ...params }
// Let GitHub figure out `name` and `tag_name` if undefined
if (!updateReleaseParams.name) {
delete updateReleaseParams.name
}
if (!updateReleaseParams.tag_name) {
delete updateReleaseParams.tag_name
}
return updateReleaseParams
}