Add a blog: Introduction to EventWatcher #5787
Merged
Conversation
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
Signed-off-by: t-kikuc <[email protected]>
Signed-off-by: t-kikuc <[email protected]>
Signed-off-by: t-kikuc <[email protected]>
Signed-off-by: t-kikuc <[email protected]>
Signed-off-by: t-kikuc <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5787 +/- ##
==========================================
+ Coverage 27.17% 27.21% +0.03%
==========================================
Files 507 506 -1
Lines 53423 53563 +140
==========================================
+ Hits 14520 14577 +57
- Misses 37796 37871 +75
- Partials 1107 1115 +8 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
khanhtc1202
reviewed
Apr 30, 2025
Comment on lines
25
to
27
| Deployment typically requires manifest changes, and PipeCD doesn't directly trigger deployments from CI pushes. | ||
|
|
||
| So, how can we "**deploy using a new image (etc.) after CI completion**"? It's annoying to manually update the manifest repo each time. |
There was a problem hiding this comment.
Suggested change
| Deployment typically requires manifest changes, and PipeCD doesn't directly trigger deployments from CI pushes. | |
| So, how can we "**deploy using a new image (etc.) after CI completion**"? It's annoying to manually update the manifest repo each time. | |
| Deployment typically requires manifest changes. So, how can we "**deploy using a new image (etc.) after CI completion**"? It's annoying to update the manifest repo manually each time. |
nits
khanhtc1202
reviewed
Apr 30, 2025
| - 1-3. Develop new app code and store the results (container images, etc.) in a container registry | ||
| - **4.** Publish an event in CI to pass the new image URI to PipeCD | ||
| - **5.** Piped detects the event | ||
| - **6.** Update the manifest repo by replacing the image URI |
There was a problem hiding this comment.
Suggested change
| - **6.** Update the manifest repo by replacing the image URI | |
| - **6.** Update the manifest repo using the data provided that belongs to the event (image URI for example) |
nits
Signed-off-by: t-kikuc <[email protected]>
khanhtc1202
reviewed
May 1, 2025
| --data=ghcr.io/xxx/helloworld:v0.2.0 | ||
| ``` | ||
|
|
||
| For GitHub Actions, using PipeCD's official `actions-event-register` is recommended (configurations are the same): |
There was a problem hiding this comment.
Suggested change
| For GitHub Actions, using PipeCD's official `actions-event-register` is recommended (configurations are the same): | |
| If you're using GitHub Actions as your CI, using PipeCD's official `actions-event-register` is recommended (configurations are the same): |
khanhtc1202
reviewed
May 1, 2025
| For GitHub Actions, using PipeCD's official `actions-event-register` is recommended (configurations are the same): | ||
|
|
||
| https://github.com/marketplace/actions/pipecd-register-event | ||
|
|
There was a problem hiding this comment.
(Example) Using actions-event-register to trigger an event named helloworld-image-update to change the image URI to ghcr.io/xxx/helloworld:v0.2.0:
- uses: pipe-cd/[email protected]
with:
api-address: ${{ secrets.API_ADDRESS }}
api-key: ${{ secrets.API_KEY }}
event-name: helloworld-image-update
data: ghcr.io/xxx/helloworld:v0.2.0I think clarify with an example could be better 👀
Signed-off-by: t-kikuc <[email protected]>
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:
as title.
translated from my own japanese article: https://zenn.dev/cadp/articles/pipecd-eventwatcher-intro
Why we need it:
EventWatcher is an essential feature, but it's so hard to understand for beginners.
Which issue(s) this PR fixes:
Does this PR introduce a user-facing change?: