Skip to content

Init alpha usage of pipedv1 and plugins#5878

Merged
t-kikuc merged 3 commits into
masterfrom
plugin/usage-alpha
May 29, 2025
Merged

Init alpha usage of pipedv1 and plugins#5878
t-kikuc merged 3 commits into
masterfrom
plugin/usage-alpha

Conversation

@t-kikuc
Copy link
Copy Markdown
Member

@t-kikuc t-kikuc commented May 27, 2025

What this PR does:

as title

Why we need it:

Early users can try pipedv1 and plugins.

Which issue(s) this PR fixes:

Part of #5615

Note

  • I'm undecided about where to locate this usage guide.

TODO :

  • This page (in other PRs)
    • Configure app.pipecd.yaml: k8s stages in pipeline and plugins.kubernetes
    • Set the URLs in the piped-config.yaml (After releasing them)
  • Outside this page
    • Release binaries of each plugin
    • Add config references for k8s, wait, example-stages plugins. (README in each dir?)

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
@t-kikuc t-kikuc requested a review from a team as a code owner May 27, 2025 06:13
@codecov
Copy link
Copy Markdown

codecov Bot commented May 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 27.85%. Comparing base (44a0c00) to head (8b8d6f6).
Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5878   +/-   ##
=======================================
  Coverage   27.85%   27.85%           
=======================================
  Files         519      519           
  Lines       55793    55793           
=======================================
  Hits        15539    15539           
  Misses      39070    39070           
  Partials     1184     1184           
Flag Coverage Δ
. 23.75% <ø> (ø)
.-pkg-app-pipedv1-plugin-example 0.00% <ø> (ø)
.-pkg-app-pipedv1-plugin-kubernetes 63.60% <ø> (ø)
.-pkg-app-pipedv1-plugin-kubernetes_multicluster 64.93% <ø> (ø)
.-pkg-app-pipedv1-plugin-wait 35.51% <ø> (ø)
.-pkg-plugin-sdk 49.25% <ø> (ø)
.-tool-actions-gh-release 19.58% <ø> (ø)
.-tool-actions-plan-preview 23.22% <ø> (ø)
.-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 on lines +1 to +4
# Usage of pipedv1 and plugins (alpha)

This page shows how to run pipedv1 and plugins of alpha status.

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.

[imo] it would be nice to clarify that this doc is WIP for now.

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.

@ffjlabo thanks, i added:

This page is still in preparation. The content will be changed and might not work well yet.

fe000f3

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
Copy link
Copy Markdown
Member

@ffjlabo ffjlabo left a comment

Choose a reason for hiding this comment

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

👍

@t-kikuc t-kikuc enabled auto-merge (squash) May 28, 2025 10:00
@t-kikuc t-kikuc changed the title add alpha usage of pipedv1 and plugins Init alpha usage of pipedv1 and plugins May 29, 2025
@khanhtc1202
Copy link
Copy Markdown
Member

@t-kikuc Nice work. My only concern is the name of the docs. I think renaming it to README.md is fine. The title of the docs speaks for itself already; there is no need to make the name -usage-alpha. WDYT?

@t-kikuc
Copy link
Copy Markdown
Member Author

t-kikuc commented May 29, 2025

@khanhtc1202

That's because README.md already exists.
https://github.com/pipe-cd/pipecd/blob/master/cmd/pipedv1/README.md

  • It (should) focus on how to run pipedv1 locally, not contain plugins config, etc.
  • It is for developers, not for users. (I guess users won't see cmd/)

How about moving or renaming after finding a better place?
For now, I want to clarify what's needed for the alpha user guide.

@khanhtc1202
Copy link
Copy Markdown
Member

@t-kikuc got that. Thank you!

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.

🫡

@t-kikuc t-kikuc merged commit c1ca195 into master May 29, 2025
40 checks passed
@t-kikuc t-kikuc deleted the plugin/usage-alpha branch May 29, 2025 10:21
@github-actions github-actions Bot mentioned this pull request Jun 2, 2025
2. Run pipedv1

```sh
docker run pipe-cd/pipecd/pipedv1:v0.52.0 piped --config-file=/path/to/piped-config.yaml --tools-dir=/tmp/piped-bin
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.

TODO: use binary instead of docker for now

@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