From e900428a472da9d3b5dbb51f94e7e68a1201180a Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Thu, 4 Jun 2026 08:01:15 -0400 Subject: [PATCH] docs: document repo support scripts --- .../scripts/secret-scanning.mjs | 8 ++++++-- .../scripts/heapsnapshot-delta.mjs | 3 +++ .../release-openclaw-ci/scripts/release-ci-summary.mjs | 4 ++++ .../scripts/verify-provider-secrets.mjs | 4 ++++ apps/android/scripts/build-release-aab.ts | 4 ++++ config/knip.config.ts | 3 +++ docs/nav-tabs-underline.js | 4 ++++ 7 files changed, 28 insertions(+), 2 deletions(-) diff --git a/.agents/skills/openclaw-secret-scanning-maintainer/scripts/secret-scanning.mjs b/.agents/skills/openclaw-secret-scanning-maintainer/scripts/secret-scanning.mjs index 2dab21dbfd84..69b4f34922b8 100644 --- a/.agents/skills/openclaw-secret-scanning-maintainer/scripts/secret-scanning.mjs +++ b/.agents/skills/openclaw-secret-scanning-maintainer/scripts/secret-scanning.mjs @@ -1,6 +1,8 @@ #!/usr/bin/env node -// Secret scanning alert handler for OpenClaw maintainers. -// Usage: node secret-scanning.mjs [options] +/** + * Secret scanning alert handler for OpenClaw maintainers. + * Usage: node secret-scanning.mjs [options] + */ import { spawnSync } from "node:child_process"; import crypto from "node:crypto"; @@ -57,6 +59,7 @@ function isBodyLocationType(locationType) { return locationType === "issue_body" || locationType === "pull_request_body"; } +/** Decides whether redacting an issue/PR body requires notifying the reporter. */ export function decideBodyRedaction(currentBody, redactedBody) { const bodyChanged = String(currentBody) !== String(redactedBody); return { @@ -65,6 +68,7 @@ export function decideBodyRedaction(currentBody, redactedBody) { }; } +/** Loads redaction-result metadata for issue/PR body secret locations. */ export function loadBodyRedactionResult(locationType, resultFile) { if (!isBodyLocationType(locationType)) { return { notify_required: true }; diff --git a/.agents/skills/openclaw-test-heap-leaks/scripts/heapsnapshot-delta.mjs b/.agents/skills/openclaw-test-heap-leaks/scripts/heapsnapshot-delta.mjs index 0ff4ddc6eeb4..f37386a4fd55 100644 --- a/.agents/skills/openclaw-test-heap-leaks/scripts/heapsnapshot-delta.mjs +++ b/.agents/skills/openclaw-test-heap-leaks/scripts/heapsnapshot-delta.mjs @@ -1,4 +1,7 @@ #!/usr/bin/env node +/** + * Heap snapshot diff utility for OpenClaw test memory leak investigations. + */ import fs from "node:fs"; import path from "node:path"; diff --git a/.agents/skills/release-openclaw-ci/scripts/release-ci-summary.mjs b/.agents/skills/release-openclaw-ci/scripts/release-ci-summary.mjs index d12dcde3e055..18fd316c0b34 100755 --- a/.agents/skills/release-openclaw-ci/scripts/release-ci-summary.mjs +++ b/.agents/skills/release-openclaw-ci/scripts/release-ci-summary.mjs @@ -1,4 +1,8 @@ #!/usr/bin/env node +/** + * Release CI summary helper that prints parent and child workflow status for a + * full release run. + */ import { execFileSync } from "node:child_process"; import process from "node:process"; diff --git a/.agents/skills/release-openclaw-ci/scripts/verify-provider-secrets.mjs b/.agents/skills/release-openclaw-ci/scripts/verify-provider-secrets.mjs index 954ed6e4a396..c3e26230ffcb 100755 --- a/.agents/skills/release-openclaw-ci/scripts/verify-provider-secrets.mjs +++ b/.agents/skills/release-openclaw-ci/scripts/verify-provider-secrets.mjs @@ -1,4 +1,8 @@ #!/usr/bin/env node +/** + * Release preflight helper that verifies required provider API keys can reach + * their model-list endpoints without printing secret values. + */ import process from "node:process"; const args = new Map(); diff --git a/apps/android/scripts/build-release-aab.ts b/apps/android/scripts/build-release-aab.ts index 625b825e6203..b50482eb87b2 100644 --- a/apps/android/scripts/build-release-aab.ts +++ b/apps/android/scripts/build-release-aab.ts @@ -1,4 +1,8 @@ #!/usr/bin/env bun +/** + * Android release helper that bumps version fields, builds release AAB variants, + * verifies signatures, and prints SHA-256 checksums. + */ import { $ } from "bun"; import { dirname, join } from "node:path"; diff --git a/config/knip.config.ts b/config/knip.config.ts index 27c363c58113..1d3266388baf 100644 --- a/config/knip.config.ts +++ b/config/knip.config.ts @@ -1,3 +1,6 @@ +/** + * Knip configuration for OpenClaw root and bundled plugin dependency hygiene. + */ const BUNDLED_PLUGIN_ROOT_DIR = "extensions"; function bundledPluginFile(pluginId: string, relativePath: string, suffix = ""): string { diff --git a/docs/nav-tabs-underline.js b/docs/nav-tabs-underline.js index d5347129666a..164f87525cd1 100644 --- a/docs/nav-tabs-underline.js +++ b/docs/nav-tabs-underline.js @@ -1,3 +1,7 @@ +/** + * Docs UI enhancement that mirrors the active nav tab underline with a stable + * animated underline element. + */ (() => { const NAV_TABS_SELECTOR = ".nav-tabs"; const ACTIVE_UNDERLINE_SELECTOR = ".nav-tabs-item > div.bg-primary";