[8.17] [CI] Prevent console.log in pipeline.ts (#204724) (#205713)

# Backport This will backport the following commits from `main` to `8.17`: - [[CI] Prevent console.log in pipeline.ts (#204724)](#204724)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Alex Szabo <[email protected]>
elastic · Jan 7, 2025 · 6f9ccb4 · 6f9ccb4
1 parent b56ed4c
commit 6f9ccb4
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 6 deletions.
diff --git a/.buildkite/pipeline-utils/buildkite/emitPipeline.ts b/.buildkite/pipeline-utils/buildkite/emitPipeline.ts
@@ -0,0 +1,13 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+export function emitPipeline(pipelineSteps: string[]) {
+  const pipelineStr = [...new Set(pipelineSteps)].join('\n');
+  console.log(pipelineStr);
+}
diff --git a/.buildkite/pipeline-utils/buildkite/index.ts b/.buildkite/pipeline-utils/buildkite/index.ts
@@ -9,3 +9,4 @@
 
 export * from './client';
 export * from './types';
+export * from './emitPipeline';
diff --git a/.buildkite/scripts/pipelines/pull_request/pipeline.ts b/.buildkite/scripts/pipelines/pull_request/pipeline.ts
@@ -7,9 +7,22 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
+/* eslint "no-restricted-syntax": [
+            "error",
+            {
+                "selector": "CallExpression[callee.object.name='console'][callee.property.name!=/^(warn|error)$/]",
+                "message": "Debug logging to stdout in this file will attempt to upload the log message as yaml to buildkite, which might result in pipeline syntax error. Use emitPipeline() to upload steps, or log to stderr."
+            }
+        ] */
+
 import fs from 'fs';
 import prConfigs from '../../../pull_requests.json';
-import { areChangesSkippable, doAnyChangesMatch, getAgentImageConfig } from '#pipeline-utils';
+import {
+  areChangesSkippable,
+  doAnyChangesMatch,
+  getAgentImageConfig,
+  emitPipeline,
+} from '#pipeline-utils';
 
 const prConfig = prConfigs.jobs.find((job) => job.pipelineSlug === 'kibana-pull-request');
 const emptyStep = `steps: []`;
@@ -35,7 +48,7 @@ const getPipeline = (filename: string, removeSteps = true) => {
     const skippable = await areChangesSkippable(SKIPPABLE_PR_MATCHERS, REQUIRED_PATHS);
 
     if (skippable) {
-      console.log(emptyStep);
+      emitPipeline([emptyStep]);
       return;
     }
 
@@ -44,8 +57,8 @@ const getPipeline = (filename: string, removeSteps = true) => {
     const onlyRunQuickChecks = await areChangesSkippable([/^renovate\.json$/], REQUIRED_PATHS);
     if (onlyRunQuickChecks) {
       pipeline.push(getPipeline('.buildkite/pipelines/pull_request/renovate.yml', false));
-
-      console.log([...new Set(pipeline)].join('\n'));
+      console.warn('Isolated changes to renovate.json. Skipping main PR pipeline.');
+      emitPipeline(pipeline);
       return;
     }
 
@@ -360,8 +373,7 @@ const getPipeline = (filename: string, removeSteps = true) => {
 
     pipeline.push(getPipeline('.buildkite/pipelines/pull_request/post_build.yml'));
 
-    // remove duplicated steps
-    console.log([...new Set(pipeline)].join('\n'));
+    emitPipeline(pipeline);
   } catch (ex) {
     console.error('Error while generating the pipeline steps: ' + ex.message, ex);
     process.exit(1);
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,3 +9,4 @@

		export * from './client';
		export * from './types';
		export * from './emitPipeline';