Skip to content

Commit 036b9da

Browse files
committed
bring docs over from other PR
1 parent 73ede33 commit 036b9da

File tree

3 files changed

+13
-5
lines changed

3 files changed

+13
-5
lines changed

action/doc.go

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
// Copyright (c) HashiCorp, Inc.
22
// SPDX-License-Identifier: MPL-2.0
33

4-
// TODO:Actions: Eventual package docs for actions
4+
// Package action contains all interfaces, request types, and response
5+
// types for an action implementation.
6+
//
7+
// In Terraform, an action is a concept which enables provider developers
8+
// to offer practitioners ad-hoc side-effects to be used in their configuration.
9+
//
10+
// The main starting point for implementations in this package is the
11+
// [Action] type which represents an instance of an action that has its
12+
// own configuration, plan, and invoke logic. The [Action] implementations
13+
// are referenced by the [provider.ProviderWithActions] type Actions method,
14+
// which enables the action practitioner usage.
515
package action

action/invoke.go

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,7 @@ type InvokeResponse struct {
2929
Diagnostics diag.Diagnostics
3030

3131
// SendProgress will immediately send a progress update to Terraform core during action invocation.
32-
// This function is provided by the framework and can be called multiple times while action logic is running.
33-
//
34-
// TODO:Actions: More documentation about when you should use this / when you shouldn't
32+
// This function is pre-populated by the framework and can be called multiple times while action logic is running.
3533
SendProgress func(event InvokeProgressEvent)
3634

3735
// TODO:Actions: Add linked resources once lifecycle/linked actions are implemented

provider/provider.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ type ProviderWithListResources interface {
138138
// ProviderWithActions is an interface type that extends Provider to
139139
// include actions for usage in practitioner configurations.
140140
//
141-
// TODO:Actions: State which Terraform version will support actions
141+
// Actions are supported in Terraform version 1.14 and later.
142142
type ProviderWithActions interface {
143143
Provider
144144

0 commit comments

Comments
 (0)