Skip to content

feat(miner): add a .gittensory-miner.env.example starter file#5357

Merged
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
jaytbarimbao-collab:feat-miner-env-example
Jul 12, 2026
Merged

feat(miner): add a .gittensory-miner.env.example starter file#5357
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
jaytbarimbao-collab:feat-miner-env-example

Conversation

@jaytbarimbao-collab

Copy link
Copy Markdown
Contributor

Adds the consolidated .gittensory-miner.env.example starter file — which docker-compose.miner.yml and packages/gittensory-miner/DEPLOYMENT.md already tell operators to cp, but which did not exist yet. It's the miner counterpart to the repo's existing .env.selfhost.example.

What this adds

A single new repo-root file enumerating every operator-facing miner env var in one copy-pasteable place, grouped by purpose:

  • Required: GITHUB_TOKEN (verified read in discover-cli.js, manage-poll.js, self-review-context.js, live-issue-snapshot.js).
  • Coding agent: MINER_CODING_AGENT_PROVIDER.
  • Optional overrides: all 19 GITTENSORY_MINER_* state-dir / per-store-DB-path / behavior vars, commented out with a note that they default under GITTENSORY_MINER_CONFIG_DIR.

Accuracy

The var set is taken from the generated authoritative reference (packages/gittensory-miner/docs/env-reference.md) plus GITHUB_TOKEN (which the prefix-scoped generator doesn't capture but the miner genuinely reads). Coding-agent model/timeout names were deliberately excluded — they are not process.env reads anywhere in the tree, so listing them as env vars would be wrong. The file header points at docs/env-reference.md as the always-current source.

Validation

  • New file only; no runtime code. Not gitignored (trackable).
  • docs:drift-check, check-miner-package, miner:env-reference:check, git diff --check: all clean. Rebased onto latest main.

Closes #5173

Add the consolidated, copy-pasteable env starter file that docker-compose.miner.yml and
DEPLOYMENT.md already reference but that did not exist yet. It enumerates GITHUB_TOKEN (required),
MINER_CODING_AGENT_PROVIDER, and all 19 GITTENSORY_MINER_* path/behavior overrides, mirroring the
existing .env.selfhost.example format and pointing at the generated docs/env-reference.md for the
always-current table.

Closes JSONbored#5173
@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

Tip

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

✅ Gittensory review result - approve/merge recommended

Review updated: 2026-07-12 14:55:35 UTC

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

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This is a pure documentation addition — a new .gittensory-miner.env.example file listing GITHUB_TOKEN as required, MINER_CODING_AGENT_PROVIDER, and 19 GITTENSORY_MINER_* optional overrides, matching the file docker-compose.miner.yml and DEPLOYMENT.md already reference. It's a new file with no runtime code, so it cannot break the build, and it fills a real gap (the referenced example file didn't exist). The description notes coding-agent model/timeout vars were deliberately excluded since they aren't actual process.env reads, which is a reasonable and well-explained scoping decision.

Nits — 6 non-blocking
  • The linked issue Add a .gittensory-miner.env.example starter file enumerating all AMS env vars, including coding-agent-driver config #5173 asks for "including coding-agent-driver config," but this PR explicitly excludes coding-agent model/timeout vars — worth a one-line callout in the PR description (already partially there) so reviewers don't think it's an oversight.
  • No way to verify from this diff alone that the 19 GITTENSORY_MINER_* vars and GITHUB_TOKEN are actually the complete/accurate set matching packages/gittensory-miner/docs/env-reference.md; trusting the author's stated validation (env-reference:check) here.
  • Consider adding this new file to any relevant .gitignore-adjacent doc listing '.gittensory-miner.env' as the copy target to make the gitignore contrast explicit for new operators.
  • If not already done, add a link to this new example file from the main README's env-var section for discoverability.
  • nit: .gittensory-miner.env.example:16 uses an active `GITHUB_TOKEN=ghp_your_token_here` placeholder; consider leaving the value empty or commented so a copied file fails obviously until the operator supplies a real token.
  • Diff looks like trivial or whitespace-only churn — Reduce whitespace-only or formatting-only churn and keep the diff focused on substantive changes.
Signal Result Evidence
Code review ✅ No blockers 2 reviewers, synthesized
Linked issue ✅ Linked #5173
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: 20 registered-repo PR(s), 9 merged, 1 issue(s).
Contributor context ✅ Confirmed Gittensor contributor jaytbarimbao-collab; Gittensor profile; 20 PR(s), 1 issue(s).
Gate result ✅ Passing No configured blocker found.
Improvement ⚠️ ℹ️ Insufficient signal risk: low · value: insufficient-signal — Nothing measurable for the structural-improvement analyzers on this PR (e.g. no code files changed). LLM value judgment: minor — It's a small, low-risk, well-scoped documentation/config-template addition that closes a real gap referenced by existing docs and an open issue, but it's inherently limited in scope (a static text file with no code).
Linked issue satisfaction

Partially addressed
The PR adds a consolidated env-example file covering GITHUB_TOKEN, MINER_CODING_AGENT_PROVIDER, and the per-store DB path overrides, but the diff shown adds only that one file — it omits the explicitly required GITTENSORY_MINER_KILL_SWITCH and GITTENSORY_MINER_LIVE_MODE vars, deliberately excludes the coding-agent model/timeout vars the issue's requirement 3 explicitly asks for, and shows no READM

Review context
  • Author: jaytbarimbao-collab
  • 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: 20 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

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 b427215 into JSONbored:main Jul 12, 2026
8 checks passed
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.

Add a .gittensory-miner.env.example starter file enumerating all AMS env vars, including coding-agent-driver config

1 participant