add logs to buildkite

Author: nsdeschenes

packages/bundler-plugin-core/src/utils/providers/Buildkite.ts

@@ -11,37 +11,63 @@ export function detect(envs: ProviderEnvs): boolean {
   return Boolean(envs?.BUILDKITE);
 }
 
-function _getBuild(inputs: ProviderUtilInputs): ProviderServiceParams["build"] {
+function _getBuild(
+  inputs: ProviderUtilInputs,
+  output: Output,
+): ProviderServiceParams["build"] {
   const { args, envs } = inputs;
   if (args?.build && args.build !== "") {
+    debug(`Using build: ${args.build}`, { enabled: output.debug });
     return args.build;
   }
-  return envs?.BUILDKITE_BUILD_NUMBER ?? null;
+  const build = envs?.BUILDKITE_BUILD_NUMBER ?? null;
+  debug(`Using build: ${build}`, { enabled: output.debug });
+  return build;
 }
 
 function _getBuildURL(
   inputs: ProviderUtilInputs,
+  output: Output,
 ): ProviderServiceParams["buildURL"] {
-  return inputs.envs?.BUILDKITE_BUILD_URL ?? null;
+  const { envs } = inputs;
+  const buildURL = envs?.BUILDKITE_BUILD_URL ?? null;
+  debug(`Using buildURL: ${buildURL}`, { enabled: output.debug });
+  return buildURL;
 }
 
 function _getBranch(
   inputs: ProviderUtilInputs,
+  output: Output,
 ): ProviderServiceParams["branch"] {
   const { args, envs } = inputs;
   if (args?.branch && args.branch !== "") {
+    debug(`Using branch: ${args.branch}`, { enabled: output.debug });
     return args.branch;
   }
-  return envs?.BUILDKITE_BRANCH ?? null;
+
+  const branch = envs?.BUILDKITE_BRANCH ?? null;
+  debug(`Using branch: ${branch}`, { enabled: output.debug });
+  return branch;
 }
 
-function _getJob(envs: ProviderEnvs): ProviderServiceParams["job"] {
-  return envs?.BUILDKITE_JOB_ID ?? null;
+function _getJob(
+  inputs: ProviderUtilInputs,
+  output: Output,
+): ProviderServiceParams["job"] {
+  const { envs } = inputs;
+  const job = envs?.BUILDKITE_JOB_ID ?? null;
+  debug(`Using job: ${job}`, { enabled: output.debug });
+  return job;
 }
 
-function _getPR(inputs: ProviderUtilInputs): ProviderServiceParams["pr"] {
+function _getPR(
+  inputs: ProviderUtilInputs,
+  output: Output,
+): ProviderServiceParams["pr"] {
   const { args } = inputs;
-  return args?.pr ?? null;
+  const pr = args?.pr ?? null;
+  debug(`Using pr: ${pr}`, { enabled: output.debug });
+  return pr;
 }
 
 export function _getService(): ProviderServiceParams["service"] {
@@ -68,13 +94,18 @@ function _getSHA(
   return envs?.BUILDKITE_COMMIT ?? null;
 }
 
-function _getSlug(inputs: ProviderUtilInputs): ProviderServiceParams["slug"] {
+function _getSlug(
+  inputs: ProviderUtilInputs,
+  output: Output,
+): ProviderServiceParams["slug"] {
   const { args, envs } = inputs;
-  return setSlug(
+  const slug = setSlug(
     args?.slug,
     envs?.BUILDKITE_ORGANIZATION_SLUG,
     envs?.BUILDKITE_PIPELINE_SLUG,
   );
+  debug(`Using slug: ${slug}`, { enabled: output.debug });
+  return slug;
 }
 
 // eslint-disable-next-line @typescript-eslint/require-await
@@ -83,14 +114,14 @@ export async function getServiceParams(
   output: Output,
 ): Promise<ProviderServiceParams> {
   return {
-    branch: _getBranch(inputs),
-    build: _getBuild(inputs),
-    buildURL: _getBuildURL(inputs),
+    branch: _getBranch(inputs, output),
+    build: _getBuild(inputs, output),
+    buildURL: _getBuildURL(inputs, output),
     commit: _getSHA(inputs, output),
-    job: _getJob(inputs.envs),
-    pr: _getPR(inputs),
+    job: _getJob(inputs, output),
+    pr: _getPR(inputs, output),
     service: _getService(),
-    slug: _getSlug(inputs),
+    slug: _getSlug(inputs, output),
   };
 }