Error Catalogue¶

This document lists the sentinel errors a GTB tool may encounter — both those defined in GTB's own pkg/ packages and those from the standalone gitlab.com/phpboyscout/go/* modules it consumes (each such section links to the owning module). 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, root.ErrNoConfigFile) {
    // prompt user to run init
}

pkg/cmd/root¶

pkg/props¶

Raised by the feature registry while a tool's feature set is being assembled at init() time. Every one is a programming error in the tool or a plugin it imports, not a runtime condition — they surface as a panic through RegisterFeature rather than something a command can recover from.

gitlab.com/phpboyscout/go/controls¶

Extracted into the standalone controls module; gtb consumes it.

gitlab.com/phpboyscout/go/errorhandling¶

Extracted into the standalone errorhandling module; gtb consumes it.

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/cmd/root¶

gitlab.com/phpboyscout/go/authn¶

Extracted into the standalone authn module; gtb consumes it.

gitlab.com/phpboyscout/go/browser¶

Extracted into the standalone browser module; gtb consumes it.

gitlab.com/phpboyscout/go/chat¶

Extracted into the standalone chat module (+ per-provider modules); gtb's pkg/chat is a thin adapter that consumes it.

gitlab.com/phpboyscout/go/credentials¶

Extracted into the standalone credentials module; gtb consumes it.

gitlab.com/phpboyscout/go/signing/openpgpkey¶

Extracted into the standalone signing module; gtb consumes it.

gitlab.com/phpboyscout/go/regexutil¶

Extracted into the standalone regexutil module; gtb consumes it.

pkg/setup¶

The signature-verification sentinels below were extracted into gitlab.com/phpboyscout/go/signing/verify; gtb's SelfUpdater re-surfaces them during Update().

gitlab.com/phpboyscout/go/signing¶

Extracted into the standalone signing module; gtb consumes it.

gitlab.com/phpboyscout/go/signing-aws-kms¶

The awskms backend — a separate module consumed by the standard gtb binary.

gitlab.com/phpboyscout/go/signing/local¶

The local PEM backend, part of the standalone signing module.

gitlab.com/phpboyscout/go/observability¶

Extracted into the standalone observability module (the OTel core, in its otelcore subpackage); gtb consumes it.

gitlab.com/phpboyscout/go/workspace¶

Extracted into the standalone workspace module; gtb consumes it.

gitlab.com/phpboyscout/go/transit¶

Extracted into the standalone transit module (shared transport middleware + resilience); gtb consumes it via the HTTP/gRPC clients. gtb's pkg/http retains only the config adapters.

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.