-
Notifications
You must be signed in to change notification settings - Fork 346
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
GA: Plugin API #1693
Labels
needs-design
Detailed design is required for implementation
Comments
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Introduction
TFLint is a Terraform static analysis framework and exposes an API for plugins to provide its functionality widely. The SDK is already 3 years old since the release of v0.1.0, and looks stable enough after migrating to gRPC.
API compatibility is important for custom ruleset developers. However, the SDK's current status is experimental, and developers must be prepared for sudden breaking changes.
Proposal
We are ending the experimental status of the TFLint plugin API and making it GA.
Plugin API compatibility is guaranteed as much as possible. Older versions of the SDK support will be dropped approximately 6 months after the next version is released. The following features assist in this gradual migration:
However, please note that we may break this promise due to significant feature changes. This is just one guideline.
Before we announce GA, the following issues are blockers:
EnsureNoError
is a bad interface tflint-plugin-sdk#196SecureConfig
tflint-plugin-sdk#192References
The text was updated successfully, but these errors were encountered: