terraform/internal/stacks/stackruntime/hooks/doc.go

// Copyright IBM Corp. 2014, 2026
// SPDX-License-Identifier: BUSL-1.1

// Package hooks is part of an optional API for callers to get realtime
// notifications of various events during the stack runtime's plan and apply
// processes.
//
// [stackruntime.Hooks] is the main entry-point into this API. This package
// contains supporting types and functions that hook implementers will typically
// need.
package hooks
stackruntime: Add HashiCorp copyright comments 2023-09-27 20:00:36 -04:00			`// Copyright IBM Corp. 2014, 2026`
			`// SPDX-License-Identifier: BUSL-1.1`

stackruntime: An extensible "hooks" API Following a similar model that we've previously used in other parts of Terraform to expose UI-oriented progress events, here we define stackruntime.Hooks as a collection of optional callbacks a caller can use to subscribe to events, and the supporting utility code to help us concisely and correctly call those hook functions from the main evaluation code without adding too much extra noise to the code. Although the primary focus of this API is driving realtime UI updates, the API design also aims to accommodate distributed tracing use-cases by allowing callers to propagate arbitrary values between related event notifications and to inject additional values into the context.Context used for downstream operations that might not be under the direct supervision of stackruntime/stackeval. 2023-07-20 13:38:19 -04:00			`// Package hooks is part of an optional API for callers to get realtime`
			`// notifications of various events during the stack runtime's plan and apply`
			`// processes.`
			`//`
			`// [stackruntime.Hooks] is the main entry-point into this API. This package`
			`// contains supporting types and functions that hook implementers will typically`
			`// need.`
			`package hooks`