Add docs for pipectl event register --contexts on the event watcher usage page #5299
Conversation
This file contains 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
ffjlabo
requested review from
nghialv,
khanhtc1202,
kentakozuka,
t-kikuc and
Warashi
as code owners
…sage page Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com>
ffjlabo
force-pushed
the
add-docs-for-event-watcher-contexts
branch
from
fccb83f
to
1fe5b8b
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5299 +/- ##
==========================================
- Coverage 25.17% 25.16% -0.01%
==========================================
Files 449 449
Lines 47642 47642
==========================================
- Hits 11992 11988 -4
- Misses 34705 34708 +3
- Partials 945 946 +1 ☔ View full report in Codecov by Sentry. |
t-kikuc
reviewed
Oct 30, 2024
| @@ -328,6 +328,8 @@ pipectl event register \ | |||
| --data=gcr.io/pipecd/example:v0.1.0 | |||
| ``` | |||
|
|
|||
| See more about [usage for Event Watcher](./event-watcher.md) | |||
There was a problem hiding this comment.
[nit]
Suggested change
| See more about [usage for Event Watcher](./event-watcher.md) | |
| See more on [usage of Event Watcher](./event-watcher.md). |
Comment on lines
186
to
187
| # For manifest repository | ||
| % git show |
There was a problem hiding this comment.
[nit] you mean this?
Suggested change
| # For manifest repository | |
| % git show | |
| # In manifest repository | |
| $ git show |
There was a problem hiding this comment.
Fixed 09c9cc2
Thanks, '%' is my terminal prompt. changed to the '$'
t-kikuc
previously approved these changes
Oct 30, 2024
Warashi
reviewed
Oct 30, 2024
| --api-key=API_KEY \ | ||
| --name=sample \ | ||
| --data=gcr.io/pipecd/helloworld:v0.48.0 \ | ||
| --contexts Source-Commit-Hash=xxxxxxx, Source-Commit-URL=https://github.com/pipe-cd/pipecd/commit/xxxxxxx |
There was a problem hiding this comment.
We have to surround the argument with quotes, or when we don't surround it we cannot put a space in the argument.
Suggested change
| --contexts Source-Commit-Hash=xxxxxxx, Source-Commit-URL=https://github.com/pipe-cd/pipecd/commit/xxxxxxx | |
| --contexts Source-Commit-Hash=xxxxxxx,Source-Commit-URL=https://github.com/pipe-cd/pipecd/commit/xxxxxxx |
There was a problem hiding this comment.
Thank you, fixed it at 4a2334a
Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com>
t-kikuc
approved these changes
Oct 31, 2024
github-actions bot
pushed a commit
that referenced
this pull request
Nov 7, 2024
…sage page (#5299) * Add docs for pipectl event register --contexts on the event watcher usage page Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> * Fix docs Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> * Fix command Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> --------- Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com>
ffjlabo
added a commit
that referenced
this pull request
Nov 7, 2024
* Add event context (#5295) * Add contexts to the RegisterEventRequest Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> * Add contexts to model.Event Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> * Store event context in Control Plane Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> * Add trailers when commiting on event watcher Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> * Fix for failed build Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> --------- Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> * Add docs for pipectl event register --contexts on the event watcher usage page (#5299) * Add docs for pipectl event register --contexts on the event watcher usage page Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> * Fix docs Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> * Fix command Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> --------- Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> * Clone manifests not to modify original manifests (#5306) Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> * Lambda: clone manifests not to modify original manifests (#5308) Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> * Skip commit and push when no replacement happens in EventWatcher (#5310) * fix: skip push if no diff exist Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * modify message Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * refactor: use noChange variable Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> --------- Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> * Execute git clean partially when drift detection for every app is done (#5312) * Execute git clean partially when drift detection for every app is done Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> * Rename to CleanPath Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> * Add test for the outside dir pattern Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> --------- Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> * Update RELEASE and docs to v0.49.3 (#5315) Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> --------- Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> Co-authored-by: Yoshiki Fujikane <40124947+ffjlabo@users.noreply.github.com> Co-authored-by: Tetsuya Kikuchi <97105818+t-kikuc@users.noreply.github.com>
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
Why we need it:
Which issue(s) this PR fixes:
Part of #5028
Related PR #5295
Does this PR introduce a user-facing change?: