@patronage/factory-ci 0.1.3 → 0.2.1

package/src/hosted-docs-only-detector.ts

@@ -1,192 +0,0 @@
-const githubExpression = (expression: string): string =>
-  `\${{ ${expression} }}`;
-
-const BASE_SHA_EXPRESSION = githubExpression(
-  "github.event_name == 'pull_request' && github.event.pull_request.base.sha || github.event.before"
-);
-const HEAD_SHA_EXPRESSION = githubExpression(
-  "github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha"
-);
-
-export interface HostedDocsOnlyClassificationPolicy {
-  readonly docsOnlyFiles?: readonly string[];
-  readonly docsOnlyMarkdownPrefixes?: readonly string[];
-  readonly docsOnlyPrefixes?: readonly string[];
-}
-
-interface NormalizedHostedDocsOnlyClassificationPolicy {
-  readonly docsOnlyFiles: readonly string[];
-  readonly docsOnlyMarkdownPrefixes: readonly string[];
-  readonly docsOnlyPrefixes: readonly string[];
-}
-
-export interface HostedDocsOnlyDetectorStep {
-  readonly continueOnError: true;
-  readonly env: Readonly<{
-    BASE_SHA: string;
-    HEAD_SHA: string;
-  }>;
-  readonly id: "docs-only";
-  readonly name: "Detect docs-only changes";
-  readonly outputs: readonly ["docs_only"];
-  readonly run: string;
-}
-
-const stringArray = (value: unknown): readonly string[] | undefined => {
-  if (value === undefined) {
-    return [];
-  }
-  if (
-    Array.isArray(value) &&
-    value.every((entry) => typeof entry === "string" && entry.length > 0)
-  ) {
-    return value;
-  }
-};
-
-const normalizePolicy = (
-  value: unknown
-): NormalizedHostedDocsOnlyClassificationPolicy | undefined => {
-  if (!(value && typeof value === "object" && !Array.isArray(value))) {
-    return;
-  }
-
-  const policy = value as Record<string, unknown>;
-  const docsOnlyFiles = stringArray(policy.docsOnlyFiles);
-  const docsOnlyMarkdownPrefixes = stringArray(policy.docsOnlyMarkdownPrefixes);
-  const docsOnlyPrefixes = stringArray(policy.docsOnlyPrefixes);
-
-  if (!(docsOnlyFiles && docsOnlyMarkdownPrefixes && docsOnlyPrefixes)) {
-    return;
-  }
-
-  return {
-    docsOnlyFiles,
-    docsOnlyMarkdownPrefixes,
-    docsOnlyPrefixes,
-  };
-};
-
-const shellQuoteSegment = (value: string): string =>
-  `'${value.replaceAll("'", String.raw`'\''`)}'`;
-
-const shellQuote = (value: string): string =>
-  value.split("$").map(shellQuoteSegment).join("'$'");
-
-const shellArray = (values: readonly string[]): string =>
-  `(${values.map(shellQuote).join(" ")})`;
-
-const shellExpansion = (name: string): string => `\${${name}}`;
-
-const malformedPolicyScript = String.raw`printf 'docs_only=false\n' >> "$GITHUB_OUTPUT"`;
-
-const detectorScript = (
-  policy: NormalizedHostedDocsOnlyClassificationPolicy
-): string => String.raw`docs_only=false
-changed_entries_file=""
-
-finish() {
-  detector_status=$?
-  if [ -n "$changed_entries_file" ]; then
-    rm -f "$changed_entries_file" || true
-  fi
-  if [ "$detector_status" -ne 0 ]; then
-    docs_only=false
-  fi
-  printf 'docs_only=%s\n' "$docs_only" >> "$GITHUB_OUTPUT"
-  exit 0
-}
-trap finish EXIT
-set -eo pipefail
-
-if [ -z "$BASE_SHA" ] || [ -z "$HEAD_SHA" ] ||
-  [ "$BASE_SHA" = "0000000000000000000000000000000000000000" ] ||
-  [ "$HEAD_SHA" = "0000000000000000000000000000000000000000" ]; then
-  exit 0
-fi
-
-changed_entries_file="$(mktemp)"
-git diff --name-status -z --find-renames --find-copies-harder \
-  "$BASE_SHA...$HEAD_SHA" -- > "$changed_entries_file"
-if [ ! -s "$changed_entries_file" ]; then
-  exit 0
-fi
-
-docs_only_files=${shellArray(policy.docsOnlyFiles)}
-docs_only_prefixes=${shellArray(policy.docsOnlyPrefixes)}
-docs_only_markdown_prefixes=${shellArray(policy.docsOnlyMarkdownPrefixes)}
-
-is_docs_only_path() {
-  candidate="$1"
-  if [ "$candidate" = "software-factory.profile.json" ]; then
-    return 1
-  fi
-  for policy_path in "${shellExpansion("docs_only_files[@]")}"; do
-    if [ "$candidate" = "$policy_path" ]; then
-      return 0
-    fi
-  done
-  for policy_path in "${shellExpansion("docs_only_prefixes[@]")}"; do
-    if [[ "$candidate" == "$policy_path"* ]]; then
-      return 0
-    fi
-  done
-  if [[ "$candidate" == *.md ]]; then
-    for policy_path in "${shellExpansion("docs_only_markdown_prefixes[@]")}"; do
-      if [[ "$candidate" == "$policy_path"* ]]; then
-        return 0
-      fi
-    done
-  fi
-  return 1
-}
-
-entry_count=0
-while IFS= read -r -d '' change_status <&3; do
-  entry_count=$((entry_count + 1))
-  case "$change_status" in
-    A|D|M)
-      IFS= read -r -d '' changed_path <&3 || exit 0
-      is_docs_only_path "$changed_path" || exit 0
-      ;;
-    R*|C*)
-      if [[ ! "$change_status" =~ ^[RC][0-9]{1,3}$ ]]; then
-        exit 0
-      fi
-      IFS= read -r -d '' source_path <&3 || exit 0
-      IFS= read -r -d '' destination_path <&3 || exit 0
-      is_docs_only_path "$source_path" || exit 0
-      is_docs_only_path "$destination_path" || exit 0
-      ;;
-    *)
-      exit 0
-      ;;
-  esac
-done 3< "$changed_entries_file"
-
-if [ "$entry_count" -gt 0 ]; then
-  docs_only=true
-fi`;
-
-/**
- * Generate the pre-install hosted detector from a consumer's canonical
- * classification policy. The returned object is structurally accepted by
- * gagen's `step()` without adding a gagen runtime dependency.
- */
-export const hostedDocsOnlyDetectorStep = (
-  policy: HostedDocsOnlyClassificationPolicy
-): HostedDocsOnlyDetectorStep => {
-  const normalized = normalizePolicy(policy);
-
-  return Object.freeze({
-    continueOnError: true as const,
-    env: Object.freeze({
-      BASE_SHA: BASE_SHA_EXPRESSION,
-      HEAD_SHA: HEAD_SHA_EXPRESSION,
-    }),
-    id: "docs-only" as const,
-    name: "Detect docs-only changes" as const,
-    outputs: ["docs_only"] as const,
-    run: normalized ? detectorScript(normalized) : malformedPolicyScript,
-  });
-};