refactor: Improve logging in processors/action chain #1338
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for endearing-brigadeiros-63f9d0 canceled.
|
|
kriswest
requested changes
Feb 6, 2026
Contributor
kriswest
left a comment
kriswest
left a comment
There was a problem hiding this comment.
Happy to see this clean-up. Needs a few small tweaks and cleanup of commented lines.
| import { getCommitConfig } from '../../../config'; | ||
|
|
||
| const isMessageAllowed = (commitMessage: string): boolean => { | ||
| const isMessageAllowed = (commitMessage: any): string | null => { |
| if (!commitMessage) { | ||
| console.log('No commit message included...'); | ||
| return false; | ||
| // console.log('No commit message included...'); |
| import { getCommitConfig } from '../../../config'; | ||
|
|
||
| const isMessageAllowed = (commitMessage: string): boolean => { | ||
| const isMessageAllowed = (commitMessage: any): string | null => { |
Contributor
There was a problem hiding this comment.
A comment explaining that a string response indicates failure would be good
Contributor
There was a problem hiding this comment.
Perhaps also renaming the function to match output style, e.g. to checkCommitMessage
| if (typeof commitMessage !== 'string') { | ||
| console.log('A non-string value has been captured for the commit message...'); | ||
| return false; | ||
| // console.log('A non-string value has been captured for the commit message...'); |
| if (literalMatches.length || patternMatches.length) { | ||
| console.log('Commit message is blocked via configured literals/patterns...'); | ||
| return false; | ||
| // console.log('Commit message is blocked via configured literals/patterns...'); |
| console.log('Invalid regex pattern...'); | ||
| return false; | ||
| // console.log('Invalid regex pattern...'); | ||
| return 'Invalid regex pattern...'; |
Contributor
There was a problem hiding this comment.
Suggested change
| return 'Invalid regex pattern...'; | |
| return 'Invalid regex pattern'; |
| const uniqueCommitMessages = [...new Set(action.commitData?.map((commit) => commit.message))]; | ||
|
|
||
| const illegalMessages = uniqueCommitMessages.filter((message) => !isMessageAllowed(message)); | ||
| // const illegalMessages = uniqueCommitMessages.filter((message) => !isMessageAllowed(message)); |
Comment on lines
+57
to
+69
| const illegalMessages = uniqueCommitMessages.filter( | ||
| (message) => isMessageAllowed(message) !== null, | ||
| ); | ||
|
|
||
| if (illegalMessages.length > 0) { | ||
| console.log(`The following commit messages are illegal: ${illegalMessages}`); | ||
| // console.log(`The following commit messages are illegal: ${illegalMessages}`); | ||
|
|
||
| step.error = true; | ||
| step.log(`The following commit messages are illegal: ${illegalMessages}`); | ||
| illegalMessages.forEach((message) => { | ||
| const error = isMessageAllowed(message); | ||
| step.log( | ||
| `Illegal commit message detected: "${message}" - Reason: ${error ?? 'Unknown reason'}`, | ||
| ); | ||
| }); |
Contributor
There was a problem hiding this comment.
Using the function twice is inefficent. Perhaps swap out filter for map, then filter the result for non-null messages
Comment on lines
+71
to
+72
| // step.error = true; | ||
| // step.log(`The following commit messages are illegal: ${illegalMessages}`); |
| } | ||
|
|
||
| console.log(`The following commit messages are legal: ${uniqueCommitMessages}`); | ||
| // console.log(`The following commit messages are legal: ${uniqueCommitMessages}`); |
Contributor
|
@RichardUri have you hit the Please click here to be authorized link yet? If you've been added to your firm's CLA it should make the EasyCLA check pass you (but you have to manually click on it) |
25 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves log data not being recorded due to use of console.log. Now properly uses step.log.
Fixes #1281