Skip to content

docs: automatic ticketing for flaky tests - #304

Merged
acatxnamedvirtue merged 4 commits into
mainfrom
tylerbeebe/auto-ticketing-docs
Jul 31, 2026
Merged

docs: automatic ticketing for flaky tests#304
acatxnamedvirtue merged 4 commits into
mainfrom
tylerbeebe/auto-ticketing-docs

Conversation

@acatxnamedvirtue

@acatxnamedvirtue acatxnamedvirtue commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Fixes TRUNK-18925

Summary

Documentation for the new auto-ticket feature (trunk2 TRD docs/trd/auto-ticket-creation.md, TRUNK-18790).

New pageflaky-tests/management/ticketing/automatic-ticketing.mdx:

  • The three independent Ticket automation toggles (auto-create on flaky, auto-create on broken, auto-close on healthy), matching the settings UI copy
  • Reopen behavior options (Reopen recent tickets / Always create a new ticket / Do nothing), the 1–99 day reopen window anchored on the provider close date, and the close/reopen target-status selectors with their provider-default fallbacks
  • Lifecycle behavior: one ticket per test, content refresh on escalation with human title edits preserved, manually created tickets never content-edited, quiet description updates vs. comments on reopen/close, auto-created badge + Events-tab attribution, rate-limit spike absorption, and the Jira one-step-transition caveat
  • A comparison table vs. webhook-based ticket creation

Updated pages:

  • Ticketing index: short Automatic ticketing section + link
  • Management Jira/Linear integration pages: Ticket automation cross-ref sections
  • Webhooks index + Jira/Linear/GitHub-Issues webhook guides: FYI callouts recommending the built-in automation for richer ticket bodies and full dashboard support, with webhooks positioned for custom workflows and other platforms (replaces the now-outdated "you only need webhooks if you want to automate ticket creation" line on the Jira/Linear guides)
  • docs.json: new page added to the Ticketing nav group

mint broken-links passes.

Draft until rollout: the feature is currently dark (LD kill switch / dogfooding). Merge when settings become customer-visible. Screenshots of the Ticket automation settings section should be added before merge.

New Automatic ticketing page covering the ticket automation settings
(auto-create on flaky/broken, auto-close on healthy, reopen behavior and
window, close/reopen target statuses) and lifecycle behavior. Cross-linked
from the ticketing index and both provider pages; webhook ticket-creation
pages gain an FYI recommending the built-in automation for Linear/Jira.
@mintlify

mintlify Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
trunk 🟢 Ready View Preview Jul 31, 2026, 3:53 PM

@acatxnamedvirtue
acatxnamedvirtue marked this pull request as ready for review July 31, 2026 16:58

@TylerJang27 TylerJang27 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.

Amazing! A few important callouts

Comment thread flaky-tests/management/ticketing/automatic-ticketing.mdx Outdated
Comment thread flaky-tests/management/ticketing/automatic-ticketing.mdx
Comment thread flaky-tests/management/ticketing/automatic-ticketing.mdx Outdated
Comment thread flaky-tests/management/ticketing/automatic-ticketing.mdx
@mintlify

mintlify Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
trunk 🟡 Building Jul 31, 2026, 3:52 PM

@acatxnamedvirtue
acatxnamedvirtue merged commit 50ee2d6 into main Jul 31, 2026
3 checks passed
@mintlify

mintlify Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Docs PR opened: #305

Added a changelog entry announcing automatic ticketing for flaky and broken tests via the Linear and Jira integrations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants