Skip to content

Fix README-usage#5944

Merged
ffjlabo merged 4 commits into
masterfrom
fix-readme-usage
Jun 13, 2025
Merged

Fix README-usage#5944
ffjlabo merged 4 commits into
masterfrom
fix-readme-usage

Conversation

@ffjlabo
Copy link
Copy Markdown
Member

@ffjlabo ffjlabo commented Jun 12, 2025

What this PR does:

Described the example k8s application with pipedv1.

Why we need it:

Which issue(s) this PR fixes:

Part of #5872

Does this PR introduce a user-facing change?:

  • How are users affected by this change:
  • Is this breaking change:
  • How to migrate (if breaking change):

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 28.48%. Comparing base (6854617) to head (835c665).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5944      +/-   ##
==========================================
- Coverage   28.49%   28.48%   -0.02%     
==========================================
  Files         520      520              
  Lines       56436    56436              
==========================================
- Hits        16082    16076       -6     
- Misses      39087    39093       +6     
  Partials     1267     1267              
Flag Coverage Δ
. 23.79% <ø> (-0.02%) ⬇️
.-pkg-app-pipedv1-plugin-example 0.00% <ø> (ø)
.-pkg-app-pipedv1-plugin-kubernetes 66.41% <ø> (ø)
.-pkg-app-pipedv1-plugin-kubernetes_multicluster 67.50% <ø> (ø)
.-pkg-app-pipedv1-plugin-wait 35.51% <ø> (ø)
.-pkg-plugin-sdk 48.86% <ø> (ø)
.-tool-actions-gh-release 19.23% <ø> (ø)
.-tool-actions-plan-preview 25.30% <ø> (ø)
.-tool-codegen-protoc-gen-auth 0.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread cmd/pipedv1/README-usage-alpha.md Outdated
# Update the workload of PRIMARY variant to the new version.
- name: K8S_PRIMARY_ROLLOUT
# Destroy all workloads of CANARY variant.
- name: K8S_CANARY_CLEAN
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[ASK]
Is plugins.kubernetes necessary or not for the k8s plugin?
I think nil plugins won't cause an error, but I don't know much about the k8s plugin.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If necessary, let's add like this:

Suggested change
- name: K8S_CANARY_CLEAN
- name: K8S_CANARY_CLEAN
plugins:
kubernetes:
.... # See k8s plugin readme for details

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For k8s plugin, the plugin config is not necesarry.
Then the plugin works with the default configuration.

@ffjlabo ffjlabo marked this pull request as ready for review June 13, 2025 04:49
@ffjlabo ffjlabo requested a review from a team as a code owner June 13, 2025 04:49
t-kikuc
t-kikuc previously approved these changes Jun 13, 2025
Copy link
Copy Markdown
Member

@t-kikuc t-kikuc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Go!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

khanhtc1202
khanhtc1202 previously approved these changes Jun 13, 2025
Copy link
Copy Markdown
Member

@khanhtc1202 khanhtc1202 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙌

@ffjlabo ffjlabo dismissed stale reviews from khanhtc1202 and t-kikuc via 993824f June 13, 2025 05:13
Copy link
Copy Markdown
Member

@Warashi Warashi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻

ffjlabo added 4 commits June 13, 2025 14:53
Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com>
Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com>
Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com>
Signed-off-by: Yoshiki Fujikane <ffjlabo@gmail.com>
@ffjlabo ffjlabo force-pushed the fix-readme-usage branch from 993824f to 835c665 Compare June 13, 2025 05:53
@ffjlabo ffjlabo enabled auto-merge (squash) June 13, 2025 05:54
@ffjlabo ffjlabo merged commit dce8029 into master Jun 13, 2025
39 of 40 checks passed
@ffjlabo ffjlabo deleted the fix-readme-usage branch June 13, 2025 05:58
@github-actions github-actions Bot mentioned this pull request Jul 14, 2025
@github-actions github-actions Bot mentioned this pull request Aug 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants