Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix package doc repeated copyright header #1054

Merged
merged 1 commit into from
Oct 31, 2024
Merged

Conversation

austinvalle
Copy link
Member

@austinvalle austinvalle commented Oct 31, 2024

Nice little bug found in our copyright headers for the new ephemeral package docs.

The repeated lines are showing up because there is a missing newline in a number of the packages, causing the header to be repeated multiple time when running go docs ephemeral

Prior to the change:
https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework@v1.13.0/ephemeral

After the change:

 $ go doc ephemeral      
package ephemeral // import "github.com/hashicorp/terraform-plugin-framework/ephemeral"

Package ephemeral contains all interfaces, request types, and response types for
an ephemeral resource implementation.

In Terraform, an ephemeral resource is a concept which enables provider
developers to offer practitioners ephemeral values, which will not be stored
in any artifact produced by Terraform (plan/state). Ephemeral resources can
optionally implement renewal logic via the (EphemeralResource).Renew method and
cleanup logic via the (EphemeralResource).Close method.

Ephemeral resources are not saved into the Terraform plan or state and can
only be referenced in other ephemeral values, such as provider configuration
attributes. Ephemeral resources are defined by a type/name, such as
"examplecloud_thing", a schema representing the structure and data types of
configuration, and lifecycle logic.

The main starting point for implementations in this package is the
EphemeralResource type which represents an instance of an ephemeral
resource that has its own configuration and lifecycle logic.
The ephemeral.EphemeralResource implementations are referenced by the
[provider.ProviderWithEphemeralResources] type EphemeralResources method,
which enables the ephemeral resource practitioner usage.

NOTE: Ephemeral resource support is experimental and exposed without
compatibility promises until these notices are removed.

type CloseRequest struct{ ... }
type CloseResponse struct{ ... }
type ConfigValidator interface{ ... }
type ConfigureRequest struct{ ... }
type ConfigureResponse struct{ ... }
type Deferred struct{ ... }
type DeferredReason int32
    const DeferredReasonUnknown DeferredReason = 0 ...
type EphemeralResource interface{ ... }
type EphemeralResourceWithClose interface{ ... }
type EphemeralResourceWithConfigValidators interface{ ... }
type EphemeralResourceWithConfigure interface{ ... }
type EphemeralResourceWithRenew interface{ ... }
type EphemeralResourceWithValidateConfig interface{ ... }
type MetadataRequest struct{ ... }
type MetadataResponse struct{ ... }
type OpenClientCapabilities struct{ ... }
type OpenRequest struct{ ... }
type OpenResponse struct{ ... }
type RenewRequest struct{ ... }
type RenewResponse struct{ ... }
type SchemaRequest struct{}
type SchemaResponse struct{ ... }
type ValidateConfigRequest struct{ ... }
type ValidateConfigResponse struct{ ... }

@austinvalle austinvalle added the documentation Improvements or additions to documentation label Oct 31, 2024
@austinvalle austinvalle requested a review from a team as a code owner October 31, 2024 19:24
@austinvalle austinvalle added this to the v1.14.0 milestone Oct 31, 2024
@austinvalle austinvalle enabled auto-merge (squash) October 31, 2024 19:29
@austinvalle austinvalle disabled auto-merge October 31, 2024 19:29
@austinvalle austinvalle enabled auto-merge (squash) October 31, 2024 19:30
@austinvalle austinvalle merged commit 5c81090 into main Oct 31, 2024
29 checks passed
@austinvalle austinvalle deleted the av/pkg-doc-fix branch October 31, 2024 20:47
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants