package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
DefaultOptionsFromEnv initializes the Options from the environment variables, falling back to placeholders if the environment is not or only partially populated.
HelpCommandAsLink returns a value for the PostRequest.HelpCommand field that prints a link to documentation to refer to.
Post either creates a new issue for a failed test, or posts a comment to an existing open issue.
ReproductionCommandFromString returns a value for the PostRequest.HelpCommand field that is a command to run.
UnitTestHelpCommand is a HelpCommand for use with UnitTestFormatter.
# Constants
CockroachPkgPrefix is the crdb package prefix.
# Variables
DefaultLabels is the default value for PostRequest.Labels.
UnitTestFormatter is the standard issue formatter for unit tests.
# Structs
EngFlowOptions configures EngFlow-specific Options.
FatalOrPanic contains a fatal error or panic obtained from a test log.
Options configures the issue poster.
A PostRequest contains the information needed to create an issue about a test failure.
A Renderer facilitates creating a reduced and opinionated subset of markdown.
RSGCrash contains information about a crash during random syntax tests obtained from a test log.
TeamCityOptions configures TeamCity-specific Options.
TemplateData is the input on which an IssueFormatter operates.
TestFailureIssue encapsulates data about an issue created or changed in order to report a test failure.
# Interfaces
An IssueFormatter turns TemplateData for a test failure into markdown that can form a GitHub issue comment.
Logger is an interface that allows callers to plug their own log implementation when they post GitHub issues.
# Type aliases
A CondensedMessage is a test log output garnished with useful helper methods that extract concise information for seamless debugging.