Files
copilotkit__copilotkit/lefthook.yml
Benjamin Taylor 6f58b2c6a4 fix(runtime): unify the Intelligence key name and publish the wiring (refs OSS-881)
Three names for one value were live in CopilotKit's own documentation, and
following the wrong one with a CLI-provisioned project yields an undefined
key:

- `INTELLIGENCE_API_KEY` — what `copilotkit project select` writes, used by
  all 34 integration examples and the docs site.
- `COPILOTKIT_INTELLIGENCE_API_KEY` — the seven Channels package READMEs and
  the packaged skills. Nothing ever read it.
- `COPILOTKIT_API_KEY` — the Slack and Teams examples, and the TSDoc on
  `CopilotKitIntelligence` itself, which is what an IDE shows on hover.

`INTELLIGENCE_API_KEY` wins, because it is the name the CLI provisions and
changing it would break every scaffolded project in the wild.
`COPILOTKIT_INTELLIGENCE_API_KEY` is retired outright — no code read it.
`COPILOTKIT_API_KEY` stays readable as a deprecated alias in the two
examples that consume it, so an existing `.env` keeps working, and is
documented as deprecated everywhere it appears.

The skills reference also documented `organizationId`, sourced from a fourth
and fifth env name, as a `CopilotKitIntelligence` option. It is not one:
`CopilotKitIntelligenceConfig` has no such field, so the copy-pasteable
sample it appeared in would not compile. Removed from the samples, and the
prose that told readers to fetch a value for it corrected.

The Intelligence wiring itself was published only inside
`node_modules/@copilotkit/runtime/skills/`, and the only docs pages showing
`CopilotKitIntelligence` were the two Channels frontends — so a developer on
the plain web path had no page to reach it from. Adds
`/premium/connect-your-runtime`, which covers the wiring, how to confirm the
credential is actually consumed, and the self-hosted two-URL rule.

`scripts/validate-intelligence-env-names.ts` keeps this from drifting back.
It runs unfiltered in CI on purpose: the two workflows that would otherwise
cover it filter paths, and static/quality ignores `examples/**` — exactly
where the deprecated alias lives.
2026-08-19 17:50:09 -05:00

130 lines
5.6 KiB
YAML

output:
- meta
- summary
- success
- failure
- execution
- execution_out
- execution_info
- skips
pre-commit:
parallel: true
commands:
check-binaries:
tags: binaries
run: bash scripts/hooks/check-binaries.sh
sync-promote-dropdown:
tags: promote-dropdown
# Regenerate the showcase_promote.yml `service` dropdown from the
# railway-envs.ts SSOT and re-stage it so the option list can never
# drift from the set of promotable services. Plain regenerate + git add
# (no stash) — keep this hook worktree-safe; lefthook's shared
# refs/stash is not safe across concurrent worktree commits.
glob: "{showcase/scripts/railway-envs.ts,showcase/scripts/sync-promote-service-options.ts,.github/workflows/showcase_promote.yml}"
run: |
set -euo pipefail
pnpm exec tsx showcase/scripts/sync-promote-service-options.ts \
&& git add .github/workflows/showcase_promote.yml
sync-lockfile:
tags: lockfile
glob: "{packages,examples,showcase/scripts}/**/package.json"
run: pnpm i --lockfile-only
stage_fixed: true
lint-fix:
tags: lint
# Scope oxlint and oxfmt to just the files staged for commit — running
# `--fix .` / `--write .` across the whole monorepo on every commit is
# both slow and blurs the hook's purpose (touch files that aren't part
# of this change). Guard against empty `{staged_files}` expansion: when
# a commit touches only non-matching files (markdown, YAML), lefthook
# still invokes this hook with an empty expansion, and oxlint/oxfmt
# would default to operating on the current directory, defeating the
# scoping entirely. stage_fixed re-stages whatever the hooks modify.
# Intentionally excludes json/jsonc/json5: oxfmt --write rewrites JSON
# files into JSON5 syntax (4-space indent, trailing commas, compact
# objects) when invoked via lefthook with staged file paths. The result
# is invalid strict JSON that pnpm rejects with ERR_PNPM_JSON_PARSE,
# blocking every commit that touches a package.json (see PRs #5054,
# #5055). JSON formatting is owned by pnpm/manual editing; oxfmt has
# no per-file knobs to keep package.json valid, so the only safe fix
# is to keep .json* out of this hook entirely.
glob: "*.{js,jsx,ts,tsx,mjs,cjs,md,css,yml,yaml,html,vue,py}"
# Mirror the generated-data ignorePatterns in .oxlintrc.json /
# .oxfmtrc.json at the hook layer.
exclude:
- "showcase/aimock/shared/**"
- "showcase/aimock/d4/**"
- "showcase/aimock/d6/**"
# Use `set --` so the staged files become positional args; this is the
# only shell-portable way to test "are there any" without breaking on
# multi-file expansion. The old `[ -n "{staged_files}" ]` form failed
# with `sh: 1: [: <path>: unexpected operator` because lefthook
# interpolates the file list as space-separated words, not a single
# quoted string, so [ saw 3+ args and tried to parse a binary op.
# IMPORTANT: keep this script DOUBLE-QUOTE-FREE. lefthook invokes a
# multi-line `run` as `sh -c "<script>"` and (in some versions / on
# Windows git-sh) does not escape embedded double quotes, so any `"$@"`
# / `[ "$#" ]` / `x=""` prematurely closes the `-c "…"` string and the
# shell aborts with `unexpected EOF`. Use unquoted `$@`/`$#` — staged
# paths in this monorepo never contain spaces. JSON is excluded from the
# glob above, so oxfmt never receives package.json (the old explicit
# package.json filter is unnecessary). ruff is scoped to .py via `case`.
run: |
files=
for f in {staged_files}; do
[ -f $f ] && files=$files' '$f
done
set -- $files
if [ $# -gt 0 ]; then
pnpm exec oxlint --fix $@
pnpm exec oxfmt --write $@
for f in $@; do
case $f in *.py) ruff format $f 2>/dev/null || true ;; esac
done
fi
stage_fixed: true
test-and-check-packages:
tags: test-packages
env:
NX_TUI: "false"
run: |
files=
for f in {staged_files}; do
case $f in
packages/*|package.json|pnpm-lock.yaml|pnpm-workspace.yaml|nx.json|tsconfig*.json) files=$files' '$f ;;
esac
done
set -- $files
if [ "$#" -gt 0 ]; then
projects=$(printf '%s\n' "$@" | pnpm nx show projects --affected --projects 'packages/*' --stdin --sep=,)
if [ -n "$projects" ]; then
pnpm nx run-many -t test,publint,attw --projects="$projects" --outputStyle=static
fi
fi
check-intelligence-env-names:
tags: intelligence-env-names
# No glob: the retired names can reappear in any doc, README, example, or
# skill, so this runs on every commit rather than a path subset.
run: pnpm check:intelligence-env-names
fail_text: |
A non-canonical Intelligence env var name was found.
The canonical name is INTELLIGENCE_API_KEY.
See scripts/validate-intelligence-env-names.ts for the allowlist.
check-plugin-skills:
tags: plugin-skills
glob: "{packages/*/skills/**,skills/runtime/**,skills/react-core/**,skills/a2ui-renderer/**,scripts/sync-plugin-skills.ts,.claude-plugin/**,packages/runtime/package.json}"
run: pnpm check:plugin-skills
fail_text: |
Plugin skill mirror is out of sync with the Intent source.
Run: pnpm sync:plugin-skills
Then stage the changes and re-commit.
commit-msg:
commands:
commitlint:
tags: commitlint
run: pnpm commitlint --edit {1}