From 1fec9ad9d7b8d737560364531e650c4f9222b7be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=AD=99=E6=8C=AF=E5=AE=87?= <> Date: Tue, 4 Feb 2025 12:03:30 +0800 Subject: [PATCH] refactor(logging): update log statements to use consistent method calls for improved readability MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 孙振宇 <> --- .../freeleaps/devops/CommitMessageLinter.groovy | 10 +++++----- .../freeleaps/devops/DependenciesResolver.groovy | 8 ++++---- first-class-pipeline/tests/Jenkinsfile | 2 +- .../vars/executeFreeleapsPipeline.groovy | 16 ++++++++-------- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/first-class-pipeline/src/com/freeleaps/devops/CommitMessageLinter.groovy b/first-class-pipeline/src/com/freeleaps/devops/CommitMessageLinter.groovy index 45328051..7e64edf9 100644 --- a/first-class-pipeline/src/com/freeleaps/devops/CommitMessageLinter.groovy +++ b/first-class-pipeline/src/com/freeleaps/devops/CommitMessageLinter.groovy @@ -10,22 +10,22 @@ class CommitMessageLinter { def lint(configurations) { 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()) { - 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 } else { 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.log.info "Commit Message Linter" "Built-in commit lint rules requires @commitlint/config-angular, ready to install it..." + 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' } - 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) { // commit lint cli requires a git repository to lint commit messages, so we need make sure the workspace is a trusted git repository diff --git a/first-class-pipeline/src/com/freeleaps/devops/DependenciesResolver.groovy b/first-class-pipeline/src/com/freeleaps/devops/DependenciesResolver.groovy index 97ad572e..39abdc47 100644 --- a/first-class-pipeline/src/com/freeleaps/devops/DependenciesResolver.groovy +++ b/first-class-pipeline/src/com/freeleaps/devops/DependenciesResolver.groovy @@ -33,17 +33,17 @@ class DependenciesResolver { steps.error("Dependencies manager is not set") } - steps.log.info "Dependencies Resolver" "Ready to resolve dependencies for ${language}..." + steps.log.info("Dependencies Resolver","Ready to resolve dependencies for ${language}...") - steps.log.info "Dependencies Resolver" "Using ${mgr.manager} to resolve dependencies..." + steps.log.info("Dependencies Resolver","Using ${mgr.manager} to resolve dependencies...") if (cachingEnabled) { - steps.log.info "Dependencies Resolver" "Dependencies caching is enabled" + steps.log.info("Dependencies Resolver","Dependencies caching is enabled") } switch (mgr) { case DependenciesManager.PIP: - steps.log.warn "Dependencies Resolver" "Python project no need to resolving dependencies, skipping..." + steps.log.warn("Dependencies Resolver","Python project no need to resolving dependencies, skipping...") break case DependenciesManager.NPM: if (configurations.npmPackageJsonFile == null || configurations.npmPackageJsonFile.isEmpty()) { diff --git a/first-class-pipeline/tests/Jenkinsfile b/first-class-pipeline/tests/Jenkinsfile index 655a1b06..d6941608 100644 --- a/first-class-pipeline/tests/Jenkinsfile +++ b/first-class-pipeline/tests/Jenkinsfile @@ -6,7 +6,7 @@ executeFreeleapsPipeline { serviceGitBranch = 'master' serviceGitRepo = "https://freeleaps@dev.azure.com/freeleaps/magicleaps/_git/magicleaps" serviceGitRepoType = 'monorepo' // monorepo, separated - executeMode = 'on-demand' // on-demand, full + executeMode = 'on-demand' // on-demand, fully commitMessageLintEnabled = true components = [ { diff --git a/first-class-pipeline/vars/executeFreeleapsPipeline.groovy b/first-class-pipeline/vars/executeFreeleapsPipeline.groovy index 7ad2ee68..4bc5df68 100644 --- a/first-class-pipeline/vars/executeFreeleapsPipeline.groovy +++ b/first-class-pipeline/vars/executeFreeleapsPipeline.groovy @@ -54,9 +54,9 @@ spec: def enabled = configurations.commitMessageLintEnabled if (enabled == null || !enabled) { - log.warn "Pipeline" "Commit message linting is disabled" + log.warn("Pipeline","Commit message linting is disabled") } else if (enabled) { - log.info "Pipeline" "Commit message linting is enabled" + log.info("Pipeline","Commit message linting is enabled") sourceFetcher.fetch(configurations) def linter = new CommitMessageLinter(this) @@ -71,13 +71,13 @@ spec: script { def executeMode = configurations.executeMode if (executeMode == null || executeMode.isEmpty()) { - log.warn "Pipeline" "Not set executeMode, using fully as default execute mode" + log.warn("Pipeline","Not set executeMode, using fully as default execute mode") env.executeMode = "fully" } else if (executeMode == 'on-demand' && serviceGitRepoType != 'monorepo') { - log.warn "Pipeline" "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" } else { - log.info "Pipeline" "Using ${executeMode} as execute mode" + log.info("Pipeline","Using ${executeMode} as execute mode") env.executeMode = executeMode } } @@ -98,7 +98,7 @@ spec: def changedComponentsDetector = new ChangedComponentsDetector(this) def changedComponents = changedComponentsDetector.detect(env.workspace, configurations.components) - log.info "Pipeline" "Changed components: ${changedComponents}" + log.info("Pipeline","Changed components: ${changedComponents}") env.changedComponents = changedComponents.join(' ') } } @@ -119,7 +119,7 @@ spec: script { def buildAgentImage = component.buildAgentImage if (buildAgentImage == null || buildAgentImage.isEmpty()) { - log.warn "Pipeline" "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) switch(language) { @@ -133,7 +133,7 @@ spec: error("Unknown service language") } - log.info "Pipeline" "Using ${buildAgentImage} as build agent image for ${component.name}" + log.info("Pipeline","Using ${buildAgentImage} as build agent image for ${component.name}") env.buildAgentImage = buildAgentImage } }