Skip to content

Docs/fix stale references and env example#42

Merged
Bhasvanth-Dev9380 merged 1 commit into
spinabot:mainfrom
Ranjithsingh2004:docs/fix-stale-references-and-env-example
Jul 4, 2026
Merged

Docs/fix stale references and env example#42
Bhasvanth-Dev9380 merged 1 commit into
spinabot:mainfrom
Ranjithsingh2004:docs/fix-stale-references-and-env-example

Conversation

@Ranjithsingh2004

@Ranjithsingh2004 Ranjithsingh2004 commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Related issues

Type of change

  • fix — bug fix
  • feat — new feature
  • docs — documentation only
  • refactor / perf / test / chore / ci

Checklist

  • npm run typecheck passes
  • npm test passes
  • npm run build compiles
  • Added/updated tests for the change
  • No secrets, real personal data, or local absolute paths in the diff
  • PR title follows Conventional Commits

Notes for reviewers

@Bhasvanth-Dev9380 Bhasvanth-Dev9380 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this, @Ranjithsingh2004 — stale-reference rot is exactly the kind of thing that goes unnoticed, so this is appreciated. I checked every change against the current tree; most of it is spot-on. A few things to sort before merge. 🦁

✅ Verified correct

  • pi SDK references (@mariozechner/pi-*@earendil-works/pi-*, 0.73.10.79.9) in AGENTS.md, skills/coding-agent/SKILL.md, and the run-main.ts comment — genuinely stale, correct fix. This is the valuable core of the PR.
  • README channels (adding Slack / Discord / iMessage / BlueBubbles) — confirmed accurate: all six are registered in src/agents/channels/bundled-channel-metas.ts and have full implementations (slack 37, discord 57, imessage 27, bluebubbles 41 .ts files). The README really was stale.
  • AGENTS.md F:\Brigade\brigade/ — good catch; removes an absolute path that AGENTS.md itself forbids.
  • .env.example — 8 of the 9 vars verified present in src/ (BRIGADE_MODE, FORCE_MODE, STRICT_MODE, ENCRYPTION_KEY/_OLD/_FILE, CONVEX_URL, ENABLE_INBOX_PERSIST).
  • media-path-guard.ts additions (encryption.key, admin-key.txt, .convex-data) — correct filenames (admin-key.txt matches convex-cmd.ts; encryption.key matches the other guards) and a genuine security hardening. Nice.

🔧 Please address before merge

1. Two code changes inside a "docs" PR.
src/core/server.ts and src/security/media-path-guard.ts are code, not docs.

  • The media-path-guard.ts denylist additions are a real security improvement 👍 — but they (and the server.ts edit) would be better as a separate fix(security): … PR so history and review focus stay clean.
  • src/core/server.ts removes "0.0.0.0/loopback-only" from LOCALHOST_BINDS. I verified it's inert — that exact string is never passed as a host anywhere (only prose comments elsewhere mention "loopback-only") — so it's harmless. But it's an undocumented behavioral-set edit with no test or rationale; please either call it out explicitly or drop it.

2. BRIGADE_HOST_ENV is itself stale.
The new .env.example block documents BRIGADE_HOST_ENV, but it exists nowhere in src/ — only in README.md. So this documents a non-functional variable. Please either wire it up or remove it from both .env.example and README.md. (It pre-existed in the README, so not introduced here — but a stale-reference pass is the right place to catch it.)

3. Fill the PR template + confirm CI.
The template is blank and the checklist is unticked. Since this touches src/, please confirm npm run typecheck, npm test, and npm run build are green, select the change type, and complete the checklist.

Once the above is sorted I'm happy to merge — thanks again for the cleanup!

@Ranjithsingh2004
Ranjithsingh2004 force-pushed the docs/fix-stale-references-and-env-example branch 2 times, most recently from 1f33a93 to 881ed05 Compare June 30, 2026 16:26
@Bhasvanth-Dev9380
Bhasvanth-Dev9380 merged commit eb15918 into spinabot:main Jul 4, 2026
8 checks passed
Bhasvanth-Dev9380 added a commit that referenced this pull request Jul 4, 2026
…vider UX

Corrections to three recently-merged contributor PRs:

- Redactor (#65): the AQ. Google-key rule had been added only to the cron
  redactor, so the sessions_history transcript path still leaked AQ./AIza keys.
  Add both Google-key rules to agents/tools/sessions/shared.ts (the real leak
  path), and tighten the cron pattern with a negative lookbehind so dotted
  identifiers (com.AQ.x, /AQ.x, token.AQ.x) are no longer over-redacted. Fix
  the stale "used by sessions_history" header comment.

- BRIGADE_HOST_ENV (#42): the documented operator override was never wired.
  Wire it as a DISPLAY-ONLY host-tag override in the system-prompt runtime line;
  process.platform stays the real value so behavioural branching (Windows shell
  hygiene) is unaffected. Restore the .env.example + README docs.

- Custom-provider onboarding (#63): the invalid-URL error never rendered (a
  silent re-prompt) — fixed with the lastError pattern. Extract
  routesToCustomProvider so the test asserts the real gate, not a re-implemented
  copy.

New tests cover the redactor (both paths + false-positive guards) and the
host-tag override.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants