Error Catalogue¶

This document lists all sentinel errors defined across GTB packages. All errors use github.com/cockroachdb/errors for wrapping and stack traces.

Use errors.Is(err, target) to check for sentinel errors — this traverses wrapped error chains correctly.

import "github.com/cockroachdb/errors"

if errors.Is(err, config.ErrNoFilesFound) {
    // prompt user to run init
}

pkg/config¶

pkg/controls¶

pkg/errorhandling¶

Constructor Functions¶

NewErrNotImplemented(issueURL string) error — creates an ErrNotImplemented error with an optional issue URL. The error handler detects this and appends the link to the user-facing output.

pkg/logger¶

pkg/vcs/github¶

pkg/cmd/root¶

pkg/authn¶

pkg/browser¶

pkg/chat¶

pkg/credentials¶

pkg/openpgpkey¶

pkg/regexutil¶

pkg/setup¶

pkg/signing¶

pkg/signing/kms¶

pkg/signing/local¶

pkg/telemetry/otelcore¶

pkg/vcs/repo¶

pkg/vcs/release¶

pkg/workspace¶

pkg/http¶

Notes¶

Internal package errors¶

The internal/ packages define additional sentinel errors for generator and code-generation use. These are not part of the public API and may change without notice:

Adding new errors¶

When adding a sentinel error to a pkg/ package:

1. Define it as a package-level var using errors.New:

   var ErrMyCondition = errors.New("description of the condition")
   

2. Add an entry to this catalogue with a description and handling guidance.
3. Use errors.Wrap(err, "context") to add call-site context when returning the error through multiple layers.