Skip to content

Commit 4234cae

Browse files
cchanchecchanche
authored
chore: use probot logger instead of @actions/core (#1520)
Unclogs terminal output when running tests
1 parent 7d6a68d commit 4234cae

4 files changed

Lines changed: 134 additions & 36 deletions

File tree

‎dist/index.js‎

Lines changed: 67 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -190201,13 +190201,29 @@ const findCommitsWithAssociatedPullRequests = async ({
190201190201
: config['initial-commits-since']
190202190202
const validationResult = Joi.date().iso().validate(since)
190203190203

190204-
core.debug(' since value: ' + since)
190205-
core.debug(
190206-
' since value validation.value: ' +
190207-
validationResult.value +
190208-
' error: ' +
190209-
validationResult.error
190210-
)
190204+
log({
190205+
context,
190206+
message: `since value: ${since}`,
190207+
debug: true,
190208+
})
190209+
log({
190210+
context,
190211+
message: `since value validation.value: ${JSON.stringify(
190212+
validationResult,
190213+
null,
190214+
2
190215+
)}`,
190216+
debug: true,
190217+
})
190218+
log({
190219+
context,
190220+
message: `since value validation.error: ${JSON.stringify(
190221+
validationResult.error,
190222+
null,
190223+
2
190224+
)}`,
190225+
debug: true,
190226+
})
190211190227

190212190228
// The validation result contains either an error or the validated value
190213190229
if (validationResult.error) {
@@ -190413,12 +190429,16 @@ exports.DEFAULT_CONFIG = DEFAULT_CONFIG
190413190429
/***/ 87707:
190414190430
/***/ ((__unused_webpack_module, exports) => {
190415190431

190416-
const log = ({ context, message, error }) => {
190432+
const log = ({ context, message, error, debug }) => {
190417190433
const repo = context.payload.repository
190418190434
const prefix = repo ? `${repo.full_name}: ` : ''
190419190435
const logString = `${prefix}${message}`
190420190436
if (error) {
190421190437
context.log.warn(error, logString)
190438+
} else if (debug) {
190439+
typeof debug === 'object'
190440+
? context.log.debug({ ...debug }, logString)
190441+
: context.log.debug({}, logString)
190422190442
} else {
190423190443
context.log.info(logString)
190424190444
}
@@ -190492,7 +190512,6 @@ exports.paginate = paginate
190492190512

190493190513
const compareVersions = __nccwpck_require__(28595)
190494190514
const regexEscape = __nccwpck_require__(31199)
190495-
const core = __nccwpck_require__(37484)
190496190515

190497190516
const { getVersionInfo } = __nccwpck_require__(1608)
190498190517
const { template } = __nccwpck_require__(96575)
@@ -190806,7 +190825,8 @@ const generateChangeLog = (mergedPullRequests, config) => {
190806190825
const resolveVersionKeyIncrement = (
190807190826
mergedPullRequests,
190808190827
config,
190809-
isPreRelease
190828+
isPreRelease,
190829+
context
190810190830
) => {
190811190831
const priorityMap = {
190812190832
patch: 1,
@@ -190822,23 +190842,35 @@ const resolveVersionKeyIncrement = (
190822190842
.flat()
190823190843
)
190824190844

190825-
core.debug('labelToKeyMap: ' + JSON.stringify(labelToKeyMap))
190845+
log({
190846+
context,
190847+
message: `labelToKeyMap`,
190848+
debug: labelToKeyMap,
190849+
})
190826190850

190827190851
const keys = mergedPullRequests
190828190852
.filter(getFilterExcludedPullRequests(config['exclude-labels']))
190829190853
.filter(getFilterIncludedPullRequests(config['include-labels']))
190830190854
.flatMap((pr) => pr.labels.nodes.map((node) => labelToKeyMap[node.name]))
190831190855
.filter(Boolean)
190832190856

190833-
core.debug('keys: ' + JSON.stringify(keys))
190857+
log({
190858+
context,
190859+
message: `keys`,
190860+
debug: keys,
190861+
})
190834190862

190835190863
const keyPriorities = keys.map((key) => priorityMap[key])
190836190864
const priority = Math.max(...keyPriorities)
190837190865
const versionKey = Object.keys(priorityMap).find(
190838190866
(key) => priorityMap[key] === priority
190839190867
)
190840190868

190841-
core.debug('versionKey: ' + versionKey)
190869+
log({
190870+
context,
190871+
message: `versionKey`,
190872+
debug: versionKey,
190873+
})
190842190874

190843190875
const versionKeyIncrement = versionKey || config['version-resolver'].default
190844190876

@@ -190888,10 +190920,15 @@ const generateReleaseInfo = ({
190888190920
const versionKeyIncrement = resolveVersionKeyIncrement(
190889190921
mergedPullRequests,
190890190922
config,
190891-
isPreRelease
190923+
isPreRelease,
190924+
context
190892190925
)
190893190926

190894-
core.debug('versionKeyIncrement: ' + versionKeyIncrement)
190927+
log({
190928+
context,
190929+
message: `versionKeyIncrement`,
190930+
debug: versionKeyIncrement,
190931+
})
190895190932

190896190933
const versionInfo = getVersionInfo(
190897190934
lastRelease,
@@ -190904,7 +190941,11 @@ const generateReleaseInfo = ({
190904190941
config['prerelease-identifier']
190905190942
)
190906190943

190907-
core.debug('versionInfo: ' + JSON.stringify(versionInfo, null, 2))
190944+
log({
190945+
context,
190946+
message: `versionInfo`,
190947+
debug: versionInfo,
190948+
})
190908190949

190909190950
if (versionInfo) {
190910190951
body = template(body, versionInfo)
@@ -190916,7 +190957,11 @@ const generateReleaseInfo = ({
190916190957
tag = template(tag, versionInfo)
190917190958
}
190918190959

190919-
core.debug('tag: ' + tag)
190960+
log({
190961+
context,
190962+
message: `tag: ${tag}`,
190963+
debug: true,
190964+
})
190920190965

190921190966
if (name === undefined) {
190922190967
name = versionInfo
@@ -190926,7 +190971,11 @@ const generateReleaseInfo = ({
190926190971
name = template(name, versionInfo)
190927190972
}
190928190973

190929-
core.debug('name: ' + name)
190974+
log({
190975+
context,
190976+
message: `name: ${name}`,
190977+
debug: true,
190978+
})
190930190979

190931190980
// Tags are not supported as `target_commitish` by Github API.
190932190981
// GITHUB_REF or the ref from webhook start with `refs/tags/`, so we handle

‎lib/commits.js‎

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -129,13 +129,29 @@ const findCommitsWithAssociatedPullRequests = async ({
129129
: config['initial-commits-since']
130130
const validationResult = Joi.date().iso().validate(since)
131131

132-
core.debug(' since value: ' + since)
133-
core.debug(
134-
' since value validation.value: ' +
135-
validationResult.value +
136-
' error: ' +
137-
validationResult.error
138-
)
132+
log({
133+
context,
134+
message: `since value: ${since}`,
135+
debug: true,
136+
})
137+
log({
138+
context,
139+
message: `since value validation.value: ${JSON.stringify(
140+
validationResult,
141+
null,
142+
2
143+
)}`,
144+
debug: true,
145+
})
146+
log({
147+
context,
148+
message: `since value validation.error: ${JSON.stringify(
149+
validationResult.error,
150+
null,
151+
2
152+
)}`,
153+
debug: true,
154+
})
139155

140156
// The validation result contains either an error or the validated value
141157
if (validationResult.error) {

‎lib/log.js‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
const log = ({ context, message, error }) => {
1+
const log = ({ context, message, error, debug }) => {
22
const repo = context.payload.repository
33
const prefix = repo ? `${repo.full_name}: ` : ''
44
const logString = `${prefix}${message}`
55
if (error) {
66
context.log.warn(error, logString)
7+
} else if (debug) {
8+
typeof debug === 'object'
9+
? context.log.debug({ ...debug }, logString)
10+
: context.log.debug({}, logString)
711
} else {
812
context.log.info(logString)
913
}

‎lib/releases.js‎

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
const compareVersions = require('compare-versions')
22
const regexEscape = require('escape-string-regexp')
3-
const core = require('@actions/core')
43

54
const { getVersionInfo } = require('./versions')
65
const { template } = require('./template')
@@ -314,7 +313,8 @@ const generateChangeLog = (mergedPullRequests, config) => {
314313
const resolveVersionKeyIncrement = (
315314
mergedPullRequests,
316315
config,
317-
isPreRelease
316+
isPreRelease,
317+
context
318318
) => {
319319
const priorityMap = {
320320
patch: 1,
@@ -330,23 +330,35 @@ const resolveVersionKeyIncrement = (
330330
.flat()
331331
)
332332

333-
core.debug('labelToKeyMap: ' + JSON.stringify(labelToKeyMap))
333+
log({
334+
context,
335+
message: `labelToKeyMap`,
336+
debug: labelToKeyMap,
337+
})
334338

335339
const keys = mergedPullRequests
336340
.filter(getFilterExcludedPullRequests(config['exclude-labels']))
337341
.filter(getFilterIncludedPullRequests(config['include-labels']))
338342
.flatMap((pr) => pr.labels.nodes.map((node) => labelToKeyMap[node.name]))
339343
.filter(Boolean)
340344

341-
core.debug('keys: ' + JSON.stringify(keys))
345+
log({
346+
context,
347+
message: `keys`,
348+
debug: keys,
349+
})
342350

343351
const keyPriorities = keys.map((key) => priorityMap[key])
344352
const priority = Math.max(...keyPriorities)
345353
const versionKey = Object.keys(priorityMap).find(
346354
(key) => priorityMap[key] === priority
347355
)
348356

349-
core.debug('versionKey: ' + versionKey)
357+
log({
358+
context,
359+
message: `versionKey`,
360+
debug: versionKey,
361+
})
350362

351363
const versionKeyIncrement = versionKey || config['version-resolver'].default
352364

@@ -396,10 +408,15 @@ const generateReleaseInfo = ({
396408
const versionKeyIncrement = resolveVersionKeyIncrement(
397409
mergedPullRequests,
398410
config,
399-
isPreRelease
411+
isPreRelease,
412+
context
400413
)
401414

402-
core.debug('versionKeyIncrement: ' + versionKeyIncrement)
415+
log({
416+
context,
417+
message: `versionKeyIncrement`,
418+
debug: versionKeyIncrement,
419+
})
403420

404421
const versionInfo = getVersionInfo(
405422
lastRelease,
@@ -412,7 +429,11 @@ const generateReleaseInfo = ({
412429
config['prerelease-identifier']
413430
)
414431

415-
core.debug('versionInfo: ' + JSON.stringify(versionInfo, null, 2))
432+
log({
433+
context,
434+
message: `versionInfo`,
435+
debug: versionInfo,
436+
})
416437

417438
if (versionInfo) {
418439
body = template(body, versionInfo)
@@ -424,7 +445,11 @@ const generateReleaseInfo = ({
424445
tag = template(tag, versionInfo)
425446
}
426447

427-
core.debug('tag: ' + tag)
448+
log({
449+
context,
450+
message: `tag: ${tag}`,
451+
debug: true,
452+
})
428453

429454
if (name === undefined) {
430455
name = versionInfo
@@ -434,7 +459,11 @@ const generateReleaseInfo = ({
434459
name = template(name, versionInfo)
435460
}
436461

437-
core.debug('name: ' + name)
462+
log({
463+
context,
464+
message: `name: ${name}`,
465+
debug: true,
466+
})
438467

439468
// Tags are not supported as `target_commitish` by Github API.
440469
// GITHUB_REF or the ref from webhook start with `refs/tags/`, so we handle

0 commit comments

Comments
 (0)