feat: support # comments in allowed-endpoints input

dist/index.js

@@ -31926,6 +31926,13 @@ function detectThirdPartyRunnerProvider() {
         return "blacksmith";
     return null;
 }
+function stripEndpointComments(input) {
+    return input
+        .split("\n")
+        .map((line) => line.trim())
+        .filter((line) => line.length > 0 && !line.startsWith("#"))
+        .join("\n");
+}
 function utils_getAnnotationLogs(platform) {
     switch (platform) {
         case "linux":

dist/post/index.js

@@ -31932,6 +31932,13 @@ function detectThirdPartyRunnerProvider() {
         return "blacksmith";
     return null;
 }
+function stripEndpointComments(input) {
+    return input
+        .split("\n")
+        .map((line) => line.trim())
+        .filter((line) => line.length > 0 && !line.startsWith("#"))
+        .join("\n");
+}
 function getAnnotationLogs(platform) {
     switch (platform) {
         case "linux":

dist/pre/index.js

@@ -85051,6 +85051,13 @@ function detectThirdPartyRunnerProvider() {
         return "blacksmith";
     return null;
 }
+function stripEndpointComments(input) {
+    return input
+        .split("\n")
+        .map((line) => line.trim())
+        .filter((line) => line.length > 0 && !line.startsWith("#"))
+        .join("\n");
+}
 function utils_getAnnotationLogs(platform) {
     switch (platform) {
         case "linux":
@@ -85827,7 +85834,7 @@ var __rest = (undefined && undefined.__rest) || function (s, e) {
             working_directory: process.env["GITHUB_WORKSPACE"],
             api_url: api_url,
             telemetry_url: STEPSECURITY_TELEMETRY_URL,
-            allowed_endpoints: lib_core.getInput("allowed-endpoints"),
+            allowed_endpoints: stripEndpointComments(lib_core.getInput("allowed-endpoints")),
             egress_policy: lib_core.getInput("egress-policy"),
             disable_telemetry: lib_core.getBooleanInput("disable-telemetry"),
             disable_sudo: lib_core.getBooleanInput("disable-sudo"),

src/setup.ts

@@ -38,7 +38,7 @@ import {
   installWindowsAgent,
 } from "./install-agent";
 
-import { chownForFolder, detectThirdPartyRunnerProvider, isAgentInstalled, isPlatformSupported, shouldDeployAgentOnSelfHosted } from "./utils";
+import { chownForFolder, detectThirdPartyRunnerProvider, isAgentInstalled, isPlatformSupported, shouldDeployAgentOnSelfHosted, stripEndpointComments } from "./utils";
 import { buildBravoConfig } from "./bravo-config";
 
 interface MonitorResponse {
@@ -82,7 +82,7 @@ interface MonitorResponse {
       working_directory: process.env["GITHUB_WORKSPACE"],
       api_url: api_url,
       telemetry_url: STEPSECURITY_TELEMETRY_URL,
-      allowed_endpoints: core.getInput("allowed-endpoints"),
+      allowed_endpoints: stripEndpointComments(core.getInput("allowed-endpoints")),
       egress_policy: core.getInput("egress-policy"),
       disable_telemetry: core.getBooleanInput("disable-telemetry"),
       disable_sudo: core.getBooleanInput("disable-sudo"),

src/utils.test.ts

@@ -1,4 +1,4 @@
-import { shouldDeployAgentOnSelfHosted, isAgentInstalled, isPlatformSupported, getAnnotationLogs, detectThirdPartyRunnerProvider } from "./utils";
+import { shouldDeployAgentOnSelfHosted, isAgentInstalled, isPlatformSupported, getAnnotationLogs, detectThirdPartyRunnerProvider, stripEndpointComments } from "./utils";
 import * as fs from "fs";
 
 jest.mock("fs", () => ({
@@ -91,6 +91,27 @@ describe("getAnnotationLogs", () => {
   });
 });
 
+describe("stripEndpointComments", () => {
+  test("removes comment lines starting with #", () => {
+    const input = "api.github.com:443\n# needed for npm\nregistry.npmjs.org:443";
+    expect(stripEndpointComments(input)).toBe("api.github.com:443\nregistry.npmjs.org:443");
+  });
+
+  test("removes blank lines", () => {
+    const input = "api.github.com:443\n\nregistry.npmjs.org:443\n";
+    expect(stripEndpointComments(input)).toBe("api.github.com:443\nregistry.npmjs.org:443");
+  });
+
+  test("returns empty string for empty input", () => {
+    expect(stripEndpointComments("")).toBe("");
+  });
+
+  test("returns empty string when input contains only comments", () => {
+    const input = "# comment one\n# comment two";
+    expect(stripEndpointComments(input)).toBe("");
+  });
+});
+
 describe("detectThirdPartyRunnerProvider", () => {
   const originalEnv = process.env;
 

src/utils.ts

@@ -51,6 +51,14 @@ export function detectThirdPartyRunnerProvider(): ThirdPartyRunnerProvider | nul
   return null;
 }
 
+export function stripEndpointComments(input: string): string {
+  return input
+    .split("\n")
+    .map((line) => line.trim())
+    .filter((line) => line.length > 0 && !line.startsWith("#"))
+    .join("\n");
+}
+
 export function getAnnotationLogs(platform: NodeJS.Platform) {
   switch (platform) {
     case "linux":