icecheng/freeleaps-ops
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor(logging): enhance log messages to include plugin context for better clarity

Browse Source 
Signed-off-by: 孙振宇 <>
This commit is contained in:
孙振宇 2025-02-04 11:32:42 +08:00
parent 682bbc5ef3
commit ae77e64ac1
4 changed files with 24 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
first-class-pipeline/src/com/freeleaps/devops/CommitMessageLinter.groovy
View File

@ -10,20 +10,22 @@ class CommitMessageLinter {
def lint(configurations) { def lint(configurations) {
def rules = '' def rules = ''
steps.log.info "<Commit Message Linter> Check if there has custom commit lint rules specified..." steps.log.info "Commit Message Linter" "Check if there has custom commit lint rules specified..."
if (configurations.commitLintRules != null && !configurations.commitLintRules.isEmpty()) { if (configurations.commitLintRules != null && !configurations.commitLintRules.isEmpty()) {
steps.log.info "<Commit Message Linter> Custom commit lint rules found, using custom rules files: ${configurations.commitLintRules}" steps.log.info "Commit Message Linter" "Custom commit lint rules found, using custom rules files: ${configurations.commitLintRules}"
rules = configurations.commitLintRules rules = configurations.commitLintRules
} else { } else {
steps.dir(steps.env.workspace) { steps.dir(steps.env.workspace) {
steps.log.info "<Commit Message Linter> No custom commit lint rules found, using built-in rules at: ${defaultRule}" steps.log.info "Commit Message Linter" "No custom commit lint rules found, using built-in rules at: ${defaultRule}"
steps.writeFile file: '.commitlintrc.js', text: steps.libraryResource(defaultRule) steps.writeFile file: '.commitlintrc.js', text: steps.libraryResource(defaultRule)
steps.log.info "Commit Message Linter" "Built-in commit lint rules requires @commitlint/config-angular, ready to install it..."
steps.sh "npm install -g @commitlint/config-angular"
} }
rules = '.commitlintrc.js' rules = '.commitlintrc.js'
} }
steps.log.info "<Commit Message Linter> Linting commit messages from HEAD..." steps.log.info "Commit Message Linter" "Linting commit messages from HEAD..."
steps.dir(steps.env.workspace) { steps.dir(steps.env.workspace) {
// commit lint cli requires a git repository to lint commit messages, so we need make sure the workspace is a trusted git repository // commit lint cli requires a git repository to lint commit messages, so we need make sure the workspace is a trusted git repository

8
first-class-pipeline/src/com/freeleaps/devops/DependenciesResolver.groovy
View File

@ -33,17 +33,17 @@ class DependenciesResolver {
steps.error("Dependencies manager is not set") steps.error("Dependencies manager is not set")
} }
steps.log.info "Ready to resolve dependencies for ${language}..." steps.log.info "Dependencies Resolver" "Ready to resolve dependencies for ${language}..."
steps.log.info "Using ${mgr.manager} to resolve dependencies..." steps.log.info "Dependencies Resolver" "Using ${mgr.manager} to resolve dependencies..."
if (cachingEnabled) { if (cachingEnabled) {
steps.log.info "Dependencies caching is enabled" steps.log.info "Dependencies Resolver" "Dependencies caching is enabled"
} }
switch (mgr) { switch (mgr) {
case DependenciesManager.PIP: case DependenciesManager.PIP:
steps.log.warn "Python project no need to resolving dependencies, skipping..." steps.log.warn "Dependencies Resolver" "Python project no need to resolving dependencies, skipping..."
break break
case DependenciesManager.NPM: case DependenciesManager.NPM:
if (configurations.npmPackageJsonFile == null || configurations.npmPackageJsonFile.isEmpty()) { if (configurations.npmPackageJsonFile == null || configurations.npmPackageJsonFile.isEmpty()) {

16
first-class-pipeline/vars/executeFreeleapsPipeline.groovy
View File

@ -54,9 +54,9 @@ spec:
def enabled = configurations.commitMessageLintEnabled def enabled = configurations.commitMessageLintEnabled
if (enabled == null || !enabled) { if (enabled == null || !enabled) {
log.warn "Commit message linting is disabled" log.warn "Pipeline" "Commit message linting is disabled"
} else if (enabled) { } else if (enabled) {
log.info "Commit message linting is enabled" log.info "Pipeline" "Commit message linting is enabled"
sourceFetcher.fetch(configurations) sourceFetcher.fetch(configurations)
def linter = new CommitMessageLinter(this) def linter = new CommitMessageLinter(this)
@ -71,13 +71,13 @@ spec:
script { script {
def executeMode = configurations.executeMode def executeMode = configurations.executeMode
if (executeMode == null || executeMode.isEmpty()) { if (executeMode == null || executeMode.isEmpty()) {
log.warn "Not set executeMode, using fully as default execute mode" log.warn "Pipeline" "Not set executeMode, using fully as default execute mode"
env.executeMode = "fully" env.executeMode = "fully"
} else if (executeMode == 'on-demand' && serviceGitRepoType != 'monorepo') { } else if (executeMode == 'on-demand' && serviceGitRepoType != 'monorepo') {
log.warn "serviceGirRepoType is not monorepo, on-demand mode is not supported, using fully mode" log.warn "Pipeline" "serviceGirRepoType is not monorepo, on-demand mode is not supported, using fully mode"
env.executeMode = "fully" env.executeMode = "fully"
} else { } else {
log.info "Using ${executeMode} as execute mode" log.info "Pipeline" "Using ${executeMode} as execute mode"
env.executeMode = executeMode env.executeMode = executeMode
} }
} }
@ -98,7 +98,7 @@ spec:
def changedComponentsDetector = new ChangedComponentsDetector(this) def changedComponentsDetector = new ChangedComponentsDetector(this)
def changedComponents = changedComponentsDetector.detect(env.workspace, configurations.components) def changedComponents = changedComponentsDetector.detect(env.workspace, configurations.components)
log.info "Changed components: ${changedComponents}" log.info "Pipeline" "Changed components: ${changedComponents}"
env.changedComponents = changedComponents.join(' ') env.changedComponents = changedComponents.join(' ')
} }
} }
@ -119,7 +119,7 @@ spec:
script { script {
def buildAgentImage = component.buildAgentImage def buildAgentImage = component.buildAgentImage
if (buildAgentImage == null || buildAgentImage.isEmpty()) { if (buildAgentImage == null || buildAgentImage.isEmpty()) {
log.warn "Not set buildAgentImage for ${component.name}, using default build agent image" log.warn "Pipeline" "Not set buildAgentImage for ${component.name}, using default build agent image"
def language = ServiceLanguage.parse(configurations.serviceLang) def language = ServiceLanguage.parse(configurations.serviceLang)
switch(language) { switch(language) {
@ -133,7 +133,7 @@ spec:
error("Unknown service language") error("Unknown service language")
} }
log.info "Using ${buildAgentImage} as build agent image for ${component.name}" log.info "Pipeline" "Using ${buildAgentImage} as build agent image for ${component.name}"
env.buildAgentImage = buildAgentImage env.buildAgentImage = buildAgentImage
} }
} }

12
first-class-pipeline/vars/log.groovy
View File

@ -8,14 +8,14 @@ def getTimestamp() {
return dateFormat.format(new Date()) return dateFormat.format(new Date())
} }
def info(message) { def info(plugin, message) {
echo "[${getTimestamp()}] [INFO] ${message}" echo "[${getTimestamp()}] [INFO] ${plugin} - ${message}"
} }
def warn(message) { def warn(plugin, message) {
echo "[${getTimestamp()}] [WARN] ${message}" echo "[${getTimestamp()}] [WARN] ${plugin} - ${message}"
} }
def error(message) { def error(plugin, message) {
echo "[${getTimestamp()}] [ERROR] ${message}" echo "[${getTimestamp()}] [ERROR] ${plugin} - ${message}"
} }