Skip to content

Commit

Permalink
docs: Remove technical preview verbiage from provider-defined functio…
Browse files Browse the repository at this point in the history
…ns (#972)

Reference: #966

Co-authored-by: Austin Valle <austinvalle@gmail.com>
  • Loading branch information
bflad and austinvalle committed Apr 15, 2024
1 parent 4a9b6a3 commit f6057df
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 21 deletions.
6 changes: 6 additions & 0 deletions .changes/unreleased/NOTES-20240329-133959.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: NOTES
body: 'function: Provider-defined function features are now considered generally available
and protected by compatibility promises'
time: 2024-03-29T13:39:59.085147-04:00
custom:
Issue: "966"
3 changes: 0 additions & 3 deletions function/definition.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ import (
)

// Definition is a function definition. Always set at least the Result field.
//
// NOTE: Provider-defined function support is in technical preview and offered
// without compatibility promises until Terraform 1.8 is generally available.
type Definition struct {
// Parameters is the ordered list of function parameters and their
// associated data types.
Expand Down
3 changes: 1 addition & 2 deletions function/function.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ import (
// Function represents an instance of a function. This is the core interface
// that all functions must implement.
//
// NOTE: Provider-defined function support is in technical preview and offered
// without compatibility promises until Terraform 1.8 is generally available.
// Provider-defined functions are supported in Terraform version 1.8 and later.
type Function interface {
// Metadata should return the name of the function, such as parse_xyz.
Metadata(context.Context, MetadataRequest, *MetadataResponse)
Expand Down
3 changes: 0 additions & 3 deletions provider/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,6 @@ type ProviderWithConfigValidators interface {
// include provider defined functions for usage in practitioner configurations.
//
// Provider-defined functions are supported in Terraform version 1.8 and later.
//
// NOTE: Provider-defined function support is in technical preview and offered
// without compatibility promises until Terraform 1.8 is generally available.
type ProviderWithFunctions interface {
Provider

Expand Down
8 changes: 1 addition & 7 deletions website/docs/plugin/framework/functions/implementation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,7 @@ description: >-

# Implement Functions

<Highlight>

Provider-defined function support is in technical preview and offered without compatibility promises until Terraform 1.8 is generally available.

</Highlight>

The framework supports implementing functions based on Terraform's [concepts for provider-defined functions](/terraform/plugin/framework/functions/concepts). It is recommended to understand those concepts before implementing a function since the terminology is used throughout this page and there are details that simplify function handling as compared to other provider concepts.
The framework supports implementing functions based on Terraform's [concepts for provider-defined functions](/terraform/plugin/framework/functions/concepts). It is recommended to understand those concepts before implementing a function since the terminology is used throughout this page and there are details that simplify function handling as compared to other provider concepts. Provider-defined functions are supported in Terraform 1.8 and later.

The main code components of a function implementation are:

Expand Down
6 changes: 0 additions & 6 deletions website/docs/plugin/framework/functions/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@ description: >-

# Functions

<Highlight>

Provider-defined function support is in technical preview and offered without compatibility promises until Terraform 1.8 is generally available.

</Highlight>

Functions are an abstraction that allow providers to expose computational logic beyond Terraform's [built-in functions](/terraform/language/functions) and simplify practitioner configurations. Provider-defined functions are supported in Terraform 1.8 and later.

<Note>
Expand Down

0 comments on commit f6057df

Please sign in to comment.