forked from requarks/changelog-action
-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.js
305 lines (270 loc) · 9.56 KB
/
index.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
const github = require('@actions/github')
const core = require('@actions/core')
const _ = require('lodash')
const cc = require('@conventional-commits/parser')
const fs = require('fs').promises
const types = [
{ types: ['feat', 'feature'], header: 'New Features', icon: ':sparkles:' },
{ types: ['fix', 'bugfix'], header: 'Bug Fixes', icon: ':bug:' },
{ types: ['perf'], header: 'Performance Improvements', icon: ':zap:' },
{ types: ['refactor'], header: 'Refactors', icon: ':recycle:' },
{ types: ['test', 'tests'], header: 'Tests', icon: ':white_check_mark:' },
{ types: ['build', 'ci'], header: 'Build System', icon: ':construction_worker:' },
{ types: ['doc', 'docs'], header: 'Documentation Changes', icon: ':memo:' },
{ types: ['style'], header: 'Code Style Changes', icon: ':art:' },
{ types: ['chore'], header: 'Chores', icon: ':wrench:' },
{ types: ['other'], header: 'Other Changes', icon: ':flying_saucer:' }
]
const rePrId = /#([0-9]+)/g
const rePrEnding = /\(#([0-9]+)\)$/
function buildSubject ({ writeToFile, subject, author, authorUrl, owner, repo }) {
const hasPR = rePrEnding.test(subject)
let final = subject
if (writeToFile) {
if (hasPR) {
const prMatch = subject.match(rePrEnding)
const msgOnly = subject.slice(0, prMatch[0].length * -1)
final = msgOnly.replace(rePrId, (m, prId) => {
return `[#${prId}](https://github.com/${owner}/${repo}/pull/${prId})`
})
final += `*(PR [#${prMatch[1]}](https://github.com/${owner}/${repo}/pull/${prMatch[1]}) by [@${author}](${authorUrl}))*`
} else {
final = subject.replace(rePrId, (m, prId) => {
return `[#${prId}](https://github.com/${owner}/${repo}/pull/${prId})`
})
final += ` *(commit by [@${author}](${authorUrl}))*`
}
} else {
if (hasPR) {
final = subject.replace(rePrEnding, (m, prId) => {
return `*(PR #${prId} by @${author})*`
})
} else {
final = `${subject} *(commit by @${author})*`
}
}
return final
}
function getTasks({ commitMsg, jiraPrefixes, jiraBrowseUrl}) {
let tasks = []
let final = ""
let prefixes = ""
if (commitMsg) {
tasks = commitMsg.match(/\S[^#]*?(\d+)/g)
}
if (jiraPrefixes) {
prefixes = jiraPrefixes.replace(/\s/g, "").split(',')
}
if (tasks && tasks.length > 0) {
tasks = tasks.map(task => task.slice(1))
final += "[ "
tasks.forEach(task => {
if (prefixes && prefixes.some(pre => task.includes(pre))) {
core.info(`Tasks with prefix: ${tasks}`)
final += `[${task}](${jiraBrowseUrl}/${task}) `
} else if (!jiraPrefixes) {
core.info(`Tasks: ${tasks}`)
final += `[${task}](${jiraBrowseUrl}/${task}) `
}
})
final += "]"
}
return final
}
async function main () {
const token = core.getInput('token')
const tag = core.getInput('tag')
const excludeTypes = (core.getInput('excludeTypes') || '').split(',').map(t => t.trim())
const writeToFile = core.getBooleanInput('writeToFile')
const useGitmojis = core.getBooleanInput('useGitmojis')
const jiraPrefixes = core.getInput('jiraPrefixes')
const jiraBrowseUrl = core.getInput('jiraBrowseUrl')
const gh = github.getOctokit(token)
const owner = github.context.repo.owner
const repo = github.context.repo.repo
const currentISODate = (new Date()).toISOString().substring(0, 10)
core.info('JiraPrefixes: ' + jiraPrefixes)
core.info('jiraBrowseUrl: ' + jiraBrowseUrl)
// GET LATEST + PREVIOUS TAGS
const tagsRaw = await gh.graphql(`
query lastTags ($owner: String!, $repo: String!) {
repository (owner: $owner, name: $repo) {
refs(first: 2, refPrefix: "refs/tags/", orderBy: { field: TAG_COMMIT_DATE, direction: DESC }) {
nodes {
name
target {
oid
}
}
}
}
}
`, {
owner,
repo
})
const latestTag = _.get(tagsRaw, 'repository.refs.nodes[0]')
const previousTag = _.get(tagsRaw, 'repository.refs.nodes[1]')
if (!latestTag) {
return core.setFailed('Couldn\'t find the latest tag. Make sure you have an existing tag already before creating a new one.')
}
if (!previousTag) {
return core.setFailed('Couldn\'t find a previous tag. Make sure you have at least 2 tags already (current tag + previous initial tag).')
}
if (latestTag.name !== tag) {
return core.setFailed('Provided tag doesn\'t match latest tag.')
}
core.info(`Using latest tag: ${latestTag.name}`)
core.info(`Using previous tag: ${previousTag.name}`)
// GET COMMITS
let curPage = 0
let totalCommits = 0
let hasMoreCommits = false
const commits = []
do {
hasMoreCommits = false
curPage++
const commitsRaw = await gh.rest.repos.compareCommitsWithBasehead({
owner,
repo,
basehead: `${previousTag.name}...${latestTag.name}`,
page: curPage,
per_page: 100
})
totalCommits = _.get(commitsRaw, 'data.total_commits', 0)
const rangeCommits = _.get(commitsRaw, 'data.commits', [])
commits.push(...rangeCommits)
if ((curPage - 1) * 100 + rangeCommits.length < totalCommits) {
hasMoreCommits = true
}
} while (hasMoreCommits)
if (!commits || commits.length < 1) {
return core.setFailed('Couldn\'t find any commits between latest and previous tags.')
}
// PARSE COMMITS
const commitsParsed = []
const breakingChanges = []
for (const commit of commits) {
try {
const cAst = cc.toConventionalChangelogFormat(cc.parser(commit.commit.message))
commitsParsed.push({
...cAst,
sha: commit.sha,
url: commit.html_url,
author: commit.author.login,
authorUrl: commit.author.html_url,
message: commit.commit.message
})
for (const note of cAst.notes) {
if (note.title === 'BREAKING CHANGE') {
breakingChanges.push({
sha: commit.sha,
url: commit.html_url,
subject: cAst.subject,
author: commit.author.login,
authorUrl: commit.author.html_url,
text: note.text
})
}
}
core.info(`[OK] Commit ${commit.sha} of type ${cAst.type} - ${cAst.subject} - ${cAst.body}`)
} catch (err) {
core.info(`[INVALID] Skipping commit ${commit.sha} as it doesn't follow conventional commit format.`)
}
}
if (commitsParsed.length < 1) {
return core.setFailed('No valid commits parsed since previous tag.')
}
// BUILD CHANGELOG
const changes = []
let idx = 0
for (const type of types) {
if (_.intersection(type.types, excludeTypes).length > 0) {
continue
}
const matchingCommits = commitsParsed.filter(c => type.types.includes(c.type))
if (matchingCommits.length < 1) {
continue
}
if (idx > 0) {
changes.push('')
}
changes.push(useGitmojis ? `### ${type.icon} ${type.header}` : `### ${type.header}`)
for (const commit of matchingCommits) {
const scope = commit.scope ? `**${commit.scope}**: ` : ''
const subject = buildSubject({
writeToFile,
subject: commit.subject,
author: commit.author,
authorUrl: commit.authorUrl,
owner,
repo
})
let tasks = undefined
if (jiraBrowseUrl) {
tasks = getTasks({
commitMsg: commit.message,
jiraPrefixes,
jiraBrowseUrl
})
}
changes.push(`- [\`${commit.sha.substring(0, 7)}\`](${commit.url}) - ${scope}${subject}${tasks}`)
}
idx++
}
if (breakingChanges.length > 0) {
changes.push('')
changes.push(useGitmojis ? '### :boom: BREAKING CHANGES' : '### BREAKING CHANGES')
for (const breakChange of breakingChanges) {
const body = breakChange.text.split('\n').map(ln => ` ${ln}`).join(' \n')
const subject = buildSubject({
writeToFile,
subject: breakChange.subject,
author: breakChange.author,
authorUrl: breakChange.authorUrl,
owner,
repo
})
changes.push(`- due to [\`${breakChange.sha.substring(0, 7)}\`](${breakChange.url}) - ${subject}:\n\n${body}\n`)
}
} else if (changes.length > 0) {
changes.push('')
} else {
return core.warning('Nothing to add to changelog because of excluded types.')
}
core.setOutput('changes', changes.join('\n'))
if (!writeToFile) { return }
// PARSE EXISTING CHANGELOG
let chglog = ''
try {
chglog = await fs.readFile('CHANGELOG.md', 'utf8')
} catch (err) {
core.info('Couldn\'t find a CHANGELOG.md, creating a new one...')
chglog = `# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
`
}
// UPDATE CHANGELOG CONTENTS
const lines = chglog.replace(/\r/g, '').split('\n')
let firstVersionLine = _.findIndex(lines, l => l.startsWith('## '))
if (firstVersionLine >= 0 && lines[firstVersionLine].startsWith(`## [${tag}`)) {
return core.notice('This version already exists in the CHANGELOG! No change will be made to the CHANGELOG.')
}
if (firstVersionLine < 0) {
firstVersionLine = lines.length
}
let output = ''
if (firstVersionLine > 0) {
output += lines.slice(0, firstVersionLine).join('\n') + '\n'
}
output += `## [${tag}] - ${currentISODate}\n${changes.join('\n')}\n`
if (firstVersionLine < lines.length) {
output += '\n' + lines.slice(firstVersionLine).join('\n')
}
output += `\n[${tag}]: https://github.com/${owner}/${repo}/compare/${previousTag.name}...${tag}`
// WRITE CHANGELOG TO FILE
await fs.writeFile('CHANGELOG.md', output)
}
main()