Skip to content

docs(miner): document coding-agent env vars - #5423

Merged
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
taillred:docs/miner-coding-agent-envs
Jul 12, 2026
Merged

docs(miner): document coding-agent env vars#5423
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
taillred:docs/miner-coding-agent-envs

Conversation

@taillred

Copy link
Copy Markdown
Contributor

Summary

Scope

  • The PR title follows type(scope): short summary Conventional Commit format, for example fix(api): restore profile access checks.
  • This PR is focused and does not mix unrelated backend, UI, MCP, docs, dependency, and deploy changes.
  • This follows CONTRIBUTING.md and does not reintroduce GitHub Pages, VitePress, site/, or CNAME.
  • I linked a currently open issue this PR resolves (e.g. Closes #123) — a linked open issue is required for every contributor PR.

Validation

  • git diff --check
  • npm run actionlint
  • npm run typecheck
  • npm run test:coverage locally; codecov/patch requires ≥99% coverage of the lines AND branches you changed (aim for 100% on your diff so CI variance does not fail near the threshold). Global coverage is a non-blocking trend with a loose 90% backstop, not the gate.
  • npm run test:workers
  • npm run build:mcp
  • npm run test:mcp-pack
  • npm run ui:openapi:check
  • npm run ui:lint
  • npm run ui:typecheck
  • npm run ui:build
  • npm audit --audit-level=moderate
  • New or changed behavior has unit/integration tests for new branches, fallback paths, and sanitizer boundaries

If any required check was skipped, explain why:

  • Docs-only change; the remaining application/build/test checks are not applicable to this patch.

Safety

  • No secrets, wallet details, hotkeys, coldkeys, user PATs, private keys, raw trust scores, private rankings, or private maintainer evidence are exposed.
  • Public GitHub text stays sanitized, low-noise, and does not imply compensation guarantees or optimization tactics.
  • Auth, cookie, CORS, GitHub App, Cloudflare, or session changes include negative-path tests.
  • API/OpenAPI/MCP behavior is updated and tested where needed.
  • UI changes use live API data or real empty/error/loading states, not production mock/demo fallbacks.
  • Visible UI changes include a UI Evidence section below with JPG/JPEG or PNG screenshots arranged as organized, captioned, clickable thumbnails. SVG screenshots are not used as review evidence. Review-only screenshots or recordings are not committed to the repository.
  • Public docs/changelogs are updated where needed; changelogs are only edited for release-prep PRs.

UI Evidence

N/A — docs-only Markdown updates; no screenshots are needed.

Notes

  • Updated packages/gittensory-miner/README.md and packages/gittensory-miner/DEPLOYMENT.md.
  • Refers readers to docs/coding-agent-driver.md for the interface contract.

@taillred
taillred requested a review from JSONbored as a code owner July 12, 2026 18:31
@superagent-security

Copy link
Copy Markdown
Contributor

Superagent didn't find any vulnerabilities or security issues in this PR.

@loopover-orb loopover-orb Bot added the gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. label Jul 12, 2026
@loopover-orb

loopover-orb Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Tip

🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩

✅ Gittensory review result - approve/merge recommended

Review updated: 2026-07-12 18:37:56 UTC

2 files · 2 AI reviewers · no blockers · readiness 100/100 · CI green · clean

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This is a docs-only PR adding a "Coding-agent driver configuration" section to both README.md and DEPLOYMENT.md, documenting MINER_CODING_AGENT_PROVIDER, MINER_CODING_AGENT_CLAUDE_MODEL, MINER_CODING_AGENT_CODEX_MODEL, and MINER_CODING_AGENT_TIMEOUT_MS. Cross-checking against packages/gittensory-engine/src/miner/driver-factory.ts confirms the provider names (noop/claude-cli/codex-cli/agent-sdk), the comma-separated fallback-list semantics, the per-provider env-key mapping (agent-sdk and noop correctly documented as ignoring model/timeout knobs), and the fail-closed behavior on an empty/unknown provider list — all accurately represented. The DEPLOYMENT.md section correctly cross-links back to the README anchor and to docs/coding-agent-driver.md, and closes the linked issue #5172 as claimed.

Nits — 5 non-blocking
  • The docs assert the CLI driver's default timeout is exactly 120000 ms — this value isn't visible in the provided driver-factory.ts excerpt, so it's worth confirming against cli-subprocess-driver.js before merge.
  • The README table lists accepted values for MINER_CODING_AGENT_PROVIDER as a fixed set but doesn't mention that names are lowercased and skip unknowns silently (parseDriverNames trims+lowercases, isConfiguredCodingAgentDriver denies unknowns) — a one-line note on case-insensitivity could help operators debugging a typo'd provider name.
  • Consider linking directly to CODING_AGENT_DRIVER_CONFIG_ENV in driver-factory.ts as the source of truth so the table doesn't silently drift if a provider's config map changes.
  • nit: packages/gittensory-miner/README.md:119 adds a new `docs/coding-agent-driver.md` link, but the provided file set does not include that target, so confirm the relative link resolves from the miner package README rather than pointing at a missing package-local doc.
  • nit: packages/gittensory-miner/README.md:124 duplicates env-var reference material while the same README already names `docs/env-reference.md` as the env-var source of truth, so confirm that generated reference contains the same four `MINER_CODING_AGENT_*` entries to avoid drift.
Signal Result Evidence
Code review ✅ No blockers 2 reviewers, synthesized
Linked issue ✅ Linked #5172
Related work ✅ No active overlap found No same-issue or scoped active PR overlap found.
Change scope ✅ 20/20 Low review scope from cached public metadata (1 linked issue).
Validation posture ✅ 25/25 PR body includes validation/test evidence.
Contributor workload ✅ 10/10 Author activity: 53 registered-repo PR(s), 34 merged, 1 issue(s).
Contributor context ✅ Confirmed Gittensor contributor luckydicer; Gittensor profile; 53 PR(s), 1 issue(s).
Gate result ✅ Passing No configured blocker found.
Improvement ⚠️ ℹ️ Insufficient signal risk: clean · value: insufficient-signal — Nothing measurable for the structural-improvement analyzers on this PR (e.g. no code files changed). LLM value judgment: minor — This is a small, well-targeted documentation addition that fills a real operator-facing gap (previously undocumented env vars) and is accurately sourced from the actual driver-factory implementation, but its scope and impact are narrow.
Linked issue satisfaction

Partially addressed
The README and DEPLOYMENT.md changes thoroughly document all four env vars with accepted values/defaults and cross-reference docs/coding-agent-driver.md as required, but the diff shows no drift-check test verifying the documented env var names/defaults match packages/gittensory-engine/src/miner/driver-factory.ts, which the issue explicitly calls out as a required deliverable.

Review context
  • Author: luckydicer
  • Role context: outside_contributor
  • Public audience mode: oss maintainer
  • Lane context: Repository is configured for direct PR review.
  • Public profile languages: not available
  • Official Gittensor activity: 53 PR(s), 1 issue(s).
  • PR-specific overlap: none found.
Contributor next steps
  • Keep the PR focused and include validation evidence before maintainer review.
Signal definitions
  • Related work = same linked issue, overlapping active PRs, or title/path similarity.
  • Change scope = cached public metadata such as size labels, draft state, and review-burden hints.
  • Validation posture = whether the PR provides enough public validation/test evidence for maintainer review.
  • Contributor workload = public contributor activity and cleanup pressure, not a repo-wide quality failure.
  • Contributor context = public GitHub/Gittensor identity context; non-Gittensor status is not a blocker.
[BETA] Chat with Gittensory

Ask Gittensory a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.

  • @gittensory ask <question> answers contribution-quality Q&A with source citations and freshness.
  • @gittensory chat <question> answers in natural prose from cached decision-pack facts via local inference (maintainer/collaborator; read-only).
  • A plain-language @gittensory mention with a real question is routed to the closest matching read-only command automatically -- no exact syntax required.

Full command reference: https://gittensory.aethereal.dev/docs/gittensory-commands

🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed


💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →.

Checked by Gittensory, a quiet PR intelligence layer for OSS maintainers.

  • Re-run Gittensory review

@loopover-orb loopover-orb Bot 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.

Gittensory approves — the gate is satisfied and CI is green.

@loopover-orb
loopover-orb Bot merged commit 328296d into JSONbored:main Jul 12, 2026
9 checks passed
JSONbored added a commit that referenced this pull request Jul 12, 2026
…audit (#5435)

Two real false positives, both currently red on main:

- The audit only scanned packages/gittensory-miner/lib and bin for env
  var reads, missing packages/gittensory-engine/src/miner/ (a real
  dependency the miner uses for coding-agent driver construction).
  MINER_CODING_AGENT_CLAUDE_MODEL/CODEX_MODEL/TIMEOUT_MS are genuinely
  read there (driver-factory.ts) but were flagged as undocumented-in-code.
- extractFilePathClaims recorded a markdown link's full target verbatim,
  including any #anchor fragment, then checked that string against
  existsSync -- so "README.md#coding-agent-driver-configuration" was
  checked as a literal (nonexistent) filename instead of "README.md"
  with a heading fragment.

Both were introduced by #5423/#5424 documenting real, working miner
config but tripping the audit's own scan gaps, not actual DEPLOYMENT.md
drift. Added a regression test for each, verified to fail on the prior
code and pass on the fix.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document MINER_CODING_AGENT_* env vars in the miner package's README and DEPLOYMENT.md

1 participant