Docs V1: Add plugin tutorial Chapter 3 - Config types and empty implementation - #7152
Merged
Merged
Conversation
…tation Signed-off-by: rahulshendre <rahulshendre789@gmail.com>
rahulshendre
requested review from
Warashi,
eeshaanSA,
khanhtc1202 and
t-kikuc
August 11, 2026 14:10
✅ Deploy Preview for pipecd-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
|
@khanhtc1202 @armistcxy @mohammedfirdouss @eeshaanSA, PTAL when you have time |
armistcxy
reviewed
Aug 25, 2026
|
|
||
| ## Define the configuration types | ||
|
|
||
| Recall the three type parameters of a DeploymentPlugin: Config, DeployTargetConfig, and ApplicationConfigSpec. The file plugin needs only one of them. |
Contributor
There was a problem hiding this comment.
I think we should wrap parameter name with ``
armistcxy
reviewed
Aug 25, 2026
|
|
||
| Recall the three type parameters of a DeploymentPlugin: Config, DeployTargetConfig, and ApplicationConfigSpec. The file plugin needs only one of them. | ||
|
|
||
| - It has no plugin-wide configuration, so it uses `sdk.ConfigNone`, the SDK's type for an empty configuration, in place of a Config type. |
Contributor
There was a problem hiding this comment.
same as above, wrap Config with ``
armistcxy
reviewed
Aug 25, 2026
| Recall the three type parameters of a DeploymentPlugin: Config, DeployTargetConfig, and ApplicationConfigSpec. The file plugin needs only one of them. | ||
|
|
||
| - It has no plugin-wide configuration, so it uses `sdk.ConfigNone`, the SDK's type for an empty configuration, in place of a Config type. | ||
| - It has no deploy targets, so its DeployTargetConfig is an empty struct. |
Contributor
There was a problem hiding this comment.
wrap DeployTargetConfig with ``
Contributor
There was a problem hiding this comment.
Pull request overview
Adds Chapter 3 to the Docs V1 “Creating a plugin” tutorial, covering the basic configuration types and a compiling (but empty) DeploymentPlugin implementation to establish a foundation for later chapters.
Changes:
- Introduces Chapter 3 documentation explaining
Config,DeployTargetConfig, andApplicationConfigSpecchoices for the sample plugin. - Adds example
plugin.gosnippets with type definitions and an initialDeploymentPluginmethod set (placeholder implementations). - Adds example
main.gosnippet showing plugin registration viasdk.NewPluginandsdk.WithDeploymentPlugin.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ## Add an empty implementation | ||
|
|
||
| Define a `plugin` type and give it a method for every method in the DeploymentPlugin interface. Each method calls `panic` for now. This lets you confirm that the method set and the signatures are correct before writing any real logic. |
| ) | ||
| ``` | ||
|
|
||
| Both `context` and `sdk` are used by the implementation you add next. |
Signed-off-by: rahulshendre <rahulshendre789@gmail.com>
rahulshendre
force-pushed
the
docs/plugin-book-ch3
branch
from
August 26, 2026 11:10
bd1a96b to
6f9549b
Compare
armistcxy
approved these changes
Aug 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does:
Adds chapter 3 of creating a plugin tutorial, it covers how to define the plugin's configuration types and add a compiling, empty DeploymentPlugin implementation.
Why we need it:
3rd chapter of the tutorial
Which issue(s) this PR fixes:
Part of #6679
Does this PR introduce a user-facing change?: