Skip to content

docs(settings): cross-reference gateDryRun and agentDryRun#5316

Merged
JSONbored merged 1 commit into
mainfrom
docs/dry-run-fields-cross-reference
Jul 12, 2026
Merged

docs(settings): cross-reference gateDryRun and agentDryRun#5316
JSONbored merged 1 commit into
mainfrom
docs/dry-run-fields-cross-reference

Conversation

@JSONbored

Copy link
Copy Markdown
Owner

Summary

Both fields use "dry run" vocabulary but gate two entirely disjoint layers with no shared code path. `gateDryRun` only computes an extra `displayConclusion` preview on the check-run — the real posted conclusion is unaffected. `agentDryRun` switches the action-layer's execution mode to suppress real GitHub mutations — entirely independent. Both fields are exposed side-by-side, unlinked, in the same maintainer-facing template.

Added explicit cross-references at all four doc sites (2 `types.ts` fields + 2 byte-synced yml example files) so neither is mistaken for a sibling/superset of the other.

Scope

Docs-only. `src/types.ts`, `.gittensory.yml.example`, `config/examples/gittensory.full.yml`.

Validation

  • `npm run typecheck` — clean
  • `npx vitest run test/unit/config-templates.test.ts` — 18/18 (template sync intact)
  • `npm run docs:drift-check` — clean

Not in this PR

A heavier alternative (rename `gateDryRun` → `gatePreviewMode`, config-as-code only, no migration needed) is optional and separate from this minimal cross-reference fix.

Closes #5291

Both fields use "dry run" vocabulary but gate two entirely disjoint
layers with no shared code path. gateDryRun only computes an extra
displayConclusion preview on the check-run -- the real posted
conclusion is unaffected. agentDryRun switches the action-layer's
execution mode to suppress real GitHub mutations -- entirely
independent. Both fields are exposed side-by-side, unlinked, in the
same maintainer-facing template.

Added explicit cross-references at all four doc sites (2 types.ts
fields + 2 byte-synced yml example files) so neither is mistaken for
a sibling/superset of the other.

Docs-only, no behavior change.

Refs #5291
@superagent-security

Copy link
Copy Markdown
Contributor

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

@codecov

codecov Bot commented Jul 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.37%. Comparing base (b7a410d) to head (18f678d).
⚠️ Report is 13 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5316   +/-   ##
=======================================
  Coverage   94.37%   94.37%           
=======================================
  Files         474      474           
  Lines       40128    40128           
  Branches    14631    14631           
=======================================
  Hits        37869    37869           
  Misses       1583     1583           
  Partials      676      676           
Flag Coverage Δ
shard-1 46.28% <ø> (-0.28%) ⬇️
shard-2 34.74% <ø> (+0.06%) ⬆️
shard-3 32.05% <ø> (-0.04%) ⬇️
shard-4 31.97% <ø> (-0.11%) ⬇️
shard-5 33.45% <ø> (-0.15%) ⬇️
shard-6 45.07% <ø> (+0.23%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
src/types.ts 100.00% <ø> (ø)
🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@JSONbored JSONbored self-assigned this Jul 12, 2026
@gittensory-orb gittensory-orb Bot added the gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. label Jul 12, 2026
@gittensory-orb

gittensory-orb Bot commented Jul 12, 2026

Copy link
Copy Markdown

Tip

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

✅ Gittensory review result - approve/merge recommended

Review updated: 2026-07-12 14:05:48 UTC

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

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This is a docs-only PR that adds cross-reference comments between gateDryRun and agentDryRun in src/types.ts and the two byte-synced yml example files, clarifying they gate disjoint layers despite the shared 'dry run' name. The changes are purely additive comment text with no code/logic touched, and the diff is consistent across all three files (types.ts JSDoc plus the two yml examples), matching the PR's stated minimal, docs-only scope and closing #5291.

Nits — 6 non-blocking
  • The comment text is duplicated near-verbatim across src/types.ts, .gittensory.yml.example, and config/examples/gittensory.full.yml — worth double-checking the docs:drift-check / config-templates sync test continues to catch any future divergence between the three sites.
  • Consider whether the heavier alternative mentioned in the PR description (renaming gateDryRun to gatePreviewMode) should get its own tracked issue if the maintainer wants to pursue it later.
  • nit: `apps/gittensory-ui/src/routes/docs.self-hosting-configuration.tsx` still describes `gate.dryRun` without the same cross-reference to `settings.agentDryRun`, so the public self-hosting docs can still leave the ambiguity in place even though the example files are clearer.
  • Add the same short cross-reference to the self-hosting configuration docs entry for `gate.dryRun`, or explain why the generated/example docs are the only intended surface for this clarification.
  • PR author also opened the linked issue — Link an issue that was opened by a different contributor, or provide a rationale for why this self-authored issue represents genuine discovery work.
  • Code changes lack test evidence — Add focused regression tests or explain why existing coverage is sufficient.
Signal Result Evidence
Code review ✅ No blockers 1 reviewer
Linked issue ✅ Linked #5291
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: 44 registered-repo PR(s), 36 merged, 476 issue(s).
Contributor context ✅ Confirmed Gittensor contributor JSONbored; Gittensor profile; 44 PR(s), 476 issue(s).
Gate result ✅ Passing No configured blocker found.
Improvement ⚠️ ℹ️ None detected risk: low · value: none — No structural-improvement signals were detected for this PR.
Review context
  • Author: JSONbored
  • Role context: owner (maintainer lane)
  • Public audience mode: oss maintainer
  • Lane context: Repository is configured for direct PR review.
  • Public profile languages: Python, TypeScript, Ruby, Go, JavaScript, MDX, Shell, Solidity
  • Official Gittensor activity: 44 PR(s), 476 issue(s).
  • PR-specific overlap: none found.
Contributor next steps
  • Treat this as maintainer-lane context rather than normal contributor-lane activity.
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 &lt;question&gt; answers contribution-quality Q&A with source citations and freshness.
  • @gittensory chat &lt;question&gt; 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

@gittensory-orb gittensory-orb Bot added the manual-review Gittensor contributor context label Jul 12, 2026
@JSONbored JSONbored merged commit 23604df into main Jul 12, 2026
18 checks passed
@JSONbored JSONbored deleted the docs/dry-run-fields-cross-reference branch July 12, 2026 14:07
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. manual-review Gittensor contributor context

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Cross-reference gateDryRun and agentDryRun so they aren't assumed to be one system

1 participant