docs(settings): cross-reference gateDryRun and agentDryRun#5316
Conversation
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 didn't find any vulnerabilities or security issues in this PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
|
Tip 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩 ✅ Gittensory review result - approve/merge recommendedReview updated: 2026-07-12 14:05:48 UTC
✅ Suggested Action - Approve/Merge
Review summary Nits — 6 non-blocking
Review context
Contributor next steps
Signal definitions
[BETA] Chat with GittensoryAsk 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.
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.
|
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
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