blog: add walkthrough of the WAIT plugin#6779
Open
sridhar-panigrahi wants to merge 2 commits into
Open
Conversation
Walks through pkg/app/pipedv1/plugin/wait/ file by file as a tutorial for contributors who want to understand pipedv1's plugin model before building their own. Includes a protocol-level diagram of how piped runs a plugin, an explanation of the restart-survival design in wait.go, and a short extension exercise. Plugin development docs in v1.0.x call out that a full English tutorial is planned but not yet written; this post is a focused stepping stone on the path to that larger work. Signed-off-by: Cyrus <sridharpanigrahi2006@gmail.com>
sridhar-panigrahi
requested review from
Warashi,
ffjlabo,
khanhtc1202 and
t-kikuc
Author
|
Friendly ping @khanhtc1202 @Warashi @t-kikuc @ffjlabo — when one of you has a moment, would appreciate a look. It's a file-by-file walkthrough of the |
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
1 participant
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 a guest blog post that walks through
pkg/app/pipedv1/plugin/wait/file-by-file as a tutorial for contributors who want to understand pipedv1's plugin model before building their own. Includes a protocol-level diagram of howpipedruns a plugin, an explanation of the restart-survival design inwait.go(stage metadata persistence), and a short extension exercise.Why we need it:
The v1 docs page on plugin development resources explicitly calls out that a full English tutorial is planned but not yet written, and links to the (Japanese) Zenn book by @Warashi. This post is a focused stepping stone toward that larger work — one plugin, read end-to-end, in English.
Which issue(s) this PR fixes:
N/A — content contribution.
Does this PR introduce a user-facing change?:
/blog/2026/05/17/reading-the-pipecd-wait-plugin-an-english-walkthrough/.