Skip to content

docs(config): add self-host review config templates in config/examples#3651

Merged
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
andriypolanski:docs/config-templates-1682
Jul 5, 2026
Merged

docs(config): add self-host review config templates in config/examples#3651
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
andriypolanski:docs/config-templates-1682

Conversation

@andriypolanski

Copy link
Copy Markdown
Contributor

Summary

  • Ship discoverable review config templates under config/examples/: gittensory.minimal.yml, gittensory.full.yml, plus TEMPLATES.md catalog.
  • Keep gittensory.full.yml body in sync with .gittensory.yml.example and gittensory.minimal.yml with .gittensory.minimal.yml — enforced in CI.
  • Document public repo-root vs private GITTENSORY_REPO_CONFIG_DIR usage, fleet notes for gittensory / awesome-claude / metagraphed, and link templates from self-host configuration docs.
  • Add parser coverage proving both new templates parse cleanly; minimal template enables no agent actions.

Closes #1682

Scope

  • config/examples/gittensory.minimal.yml — minimal safe starter (public or private mount)
  • config/examples/gittensory.full.yml — exhaustive template (synced body with .gittensory.yml.example)
  • config/examples/TEMPLATES.md — catalog, usage, fleet examples without private policy
  • config/examples/README.md — links to new templates
  • .gittensory.yml.example — points at config/examples/ copies
  • apps/gittensory-ui/src/routes/docs.self-hosting-configuration.tsx — Config templates section
  • test/unit/config-templates.test.ts — parse + sync drift guard
  • No src/** production code changes (Codecov patch N/A for parser logic)

Changed files

File Change
config/examples/gittensory.minimal.yml New — minimal starter with public/private header
config/examples/gittensory.full.yml New — exhaustive template (body synced with root example)
config/examples/TEMPLATES.md New — template catalog + fleet usage notes
config/examples/README.md Link TEMPLATES.md and in-directory template paths
.gittensory.yml.example Cross-link config/examples/ starter paths
apps/gittensory-ui/src/routes/docs.self-hosting-configuration.tsx Config templates section + links
test/unit/config-templates.test.ts Parse tests + canonical-body sync checks

Validation

git diff --check
npx vitest run test/unit/config-templates.test.ts test/unit/selfhost-config-examples.test.ts test/unit/focus-manifest.test.ts
npm run docs:drift-check
npm --workspace @jsonbored/gittensory-ui run lint
npm --workspace @jsonbored/gittensory-ui run typecheck
npm run test:ci
npm audit --audit-level=moderate

Safety

  • Example files contain only generic placeholders — no real maintainer logins, secrets, or private policy
  • Private-only examples (global.gittensory.yml, repo-override.gittensory.yml) unchanged except README cross-links
  • Docs-only + template files — no runtime behavior change

@andriypolanski
andriypolanski requested a review from JSONbored as a code owner July 5, 2026 23:08
@superagent-security

Copy link
Copy Markdown
Contributor

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

@codecov

codecov Bot commented Jul 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.28%. Comparing base (a151d8a) to head (6c74f0f).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3651   +/-   ##
=======================================
  Coverage   93.28%   93.28%           
=======================================
  Files         314      314           
  Lines       32054    32054           
  Branches    11747    11747           
=======================================
  Hits        29903    29903           
  Misses       1517     1517           
  Partials      634      634           
🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@loopover-orb loopover-orb Bot added the gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. label Jul 5, 2026
@loopover-orb

loopover-orb Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Warning

🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨

⏸️ Gittensory review result - manual review recommended

Review updated: 2026-07-05 23:20:24 UTC

8 files · 1 AI reviewer · no blockers · readiness 62/100 · CI green · clean

⏸️ Suggested Action - Manual Review

Review summary
This PR adds discoverable self-host config templates (config/examples/gittensory.minimal.yml, gittensory.full.yml, TEMPLATES.md) plus doc-page links and a CI-enforced sync test proving the full/minimal templates stay byte-identical to the canonical .gittensory.yml.example/.gittensory.minimal.yml from a marker onward and parse cleanly with zero warnings. It's a docs/config-only change (no src/** touched), tightly scoped to issue #1682, and the sync-guard test is real rather than fabricated since both markers genuinely appear in the diffed files on both sides. The main soft spot is that TEMPLATES.md and the docs page reference two sibling template files (global.gittensory.yml, repo-override.gittensory.yml) that aren't part of this diff, so their existence/content can't be verified from what's shown here.

Nits — 7 non-blocking
  • config/examples/TEMPLATES.md and apps/gittensory-ui/src/routes/docs.self-hosting-configuration.tsx link to config/examples/global.gittensory.yml and repo-override.gittensory.yml, which aren't in this diff's changed-file set — confirm those files already exist so the catalog table and `cp` instructions aren't pointing at dead paths.
  • docs.self-hosting-configuration.tsx:145-160 hardcodes several github.com/JSONbored/gittensory/blob/main/... URLs; a shared base-URL constant would avoid hunting down each literal on a future default-branch rename (pre-existing pattern, not new debt from this diff).
  • gittensory.full.yml carries over non-inclusive terms (`blacklist`, `master`) from the existing .gittensory.yml.example field names (contributorBlacklist, blacklistLabel) — not fixable here without desyncing from the canonical schema, but worth a follow-up issue if those field names are ever renamed.
  • test/unit/config-templates.test.ts's marker-based body comparison is a good drift guard, but a short comment explaining why it compares from a marker (not the whole file) would help future editors understand the header sections are intentionally allowed to diverge.
  • Add a line in TEMPLATES.md's catalog table confirming global.gittensory.yml / repo-override.gittensory.yml predate this PR, or link them explicitly, so reviewers don't have to guess.
  • Diff looks like trivial or whitespace-only churn — Reduce whitespace-only or formatting-only churn and keep the diff focused on substantive changes.
  • Readiness score is below the configured threshold — Use the readiness panel as advisory maintainer context; the score does not block this PR.
Signal Result Evidence
Code review ✅ No blockers 1 reviewer
Linked issue ✅ Linked #1682
Related work ⚠️ 1 scoped overlap Top overlaps are listed below; lower-confidence bulk is hidden.
Change scope ❌ 8/20 High review scope from cached public metadata (1 linked issue).
Validation posture ❌ 5/25 Preflight is holding this PR: the review lane is unavailable, so it is not ready for automated review.
Contributor workload ✅ 10/10 Author activity: 123 registered-repo PR(s), 75 merged, 5 issue(s).
Contributor context ✅ Confirmed Gittensor contributor andriypolanski; Gittensor profile; 123 PR(s), 5 issue(s).
Gate result ✅ Passing No configured blocker found.
Review context
  • Author: andriypolanski
  • Role context: outside_contributor
  • Public audience mode: oss maintainer
  • Lane context: Repository registration is not available in the local Gittensory cache.
  • Public profile languages: TypeScript, JavaScript, Python, Rust, Cuda, Kotlin, MDX, Scala
  • Official Gittensor activity: 123 PR(s), 5 issue(s).
  • Related work: Titles/paths share 5 meaningful terms. (issue #1683, issue #1681)
Contributor next steps
  • Review top overlaps.
  • Add a concise scope and risk note.
  • Await review-lane availability.
  • Refresh registry data or choose a registered active repo.
  • Check active issues and PRs before submitting.
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.

🟩 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 881bed2 into JSONbored:main Jul 5, 2026
9 checks passed
@andriypolanski
andriypolanski deleted the docs/config-templates-1682 branch July 16, 2026 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(selfhost): add complete and minimal review config templates

1 participant