feat: add new commands for completion and migration in pipectl - #6751
vedantlavale wants to merge 11 commits into
Conversation
Signed-off-by: vedantlavale <vedantlavale@gmail.com>
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the pipectl CLI user guide docs to reflect current commands, removing references to the deprecated init workflow and documenting newer migrate and plugin functionality.
Changes:
- Updates “Available Commands” to remove
initand addcompletion,migrate, andplugin - Replaces the removed
pipectl initdocumentation withpipectl migratedocumentation (application-config + database) - Adds documentation for
pipectl plugin push
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/content/en/docs-v1.0.x/user-guide/command-line-tool.md | Updates the documented CLI help output to match current commands |
| docs/content/en/docs-dev/user-guide/command-line-tool.md | Updates command list and replaces init docs with migrate and plugin push documentation |
|
@khanhtc1202 , @rahulshendre , @Ayushmore1214 hey, could someone take a look at this when free? |
|
Hey @vedantlavale, sorry for the delay, we missed this earlier. Please have a look at this comment - here. Let's discuss more of the changes needed in the docs with the maintainers in the next community meeting before proceeding further. Since @A-d-i-t-y is also working in a similar area, it would be great if you both could coordinate on the related changes. |
|
This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days. |
|
@rahulshendre @Ayushmore1214 This PR has been approved for a while now and has gone stale. Are we planning to merge it, or is there anything else that needs to be addressed from my side? |
cc @khanhtc1202 |
rahulshendre
left a comment
rahulshendre
left a comment
There was a problem hiding this comment.
Hey @vedantlavale, sorry this sat so long, overall LGTM
v0.57 tag and pipectl is the same CLI across versions (migrate, plugin, transfer all there, init already gone)
so the command reference should really match across docs-dev, docs-v1.0.x and docs-v0.57.x, and right now it's out of sync
also transfer is missing from the available commands list, and it's not in docs-dev either, so that needs adding too
just the command sections though, no need to copy the whole page across. once those match I think it's good to go : )
| See [Feature Status](../feature-status/_index.md#pipectl-init). | ||
| The `--files` flag maps platforms to binary files in `os/arch=filepath` format. All of `--files`, `--tag`, `--registry`, and `--repository` are required. Add `--insecure` to skip TLS verification when using an HTTP-only registry. | ||
|
|
||
| ### You want more? |
There was a problem hiding this comment.
Sounds too informal. Please fix.
eeshaanSA
left a comment
eeshaanSA
left a comment
There was a problem hiding this comment.
LGTM, good work @vedantlavale. Thanks for this. Just fix the comment and I think it is good to go.
|
Also, just realised, the transfer command is missing, as @rahulshendre pointed out. Please take a look at this file to better understand how pipectl works. |
|
yeah sure! |
|
@vedantlavale any updates on this one 👀 |
|
@rahulshendre hey yes, on it. missed the notifs |
Signed-off-by: vedantlavale <vedantlavale@gmail.com>
b08e88a to
93c7b2b
Compare
|
@rahulshendre done, can you check it. and lmk if any changes |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #6751 +/- ##
==========================================
+ Coverage 29.51% 38.46% +8.94%
==========================================
Files 601 12 -589
Lines 64336 663 -63673
==========================================
- Hits 18987 255 -18732
+ Misses 43869 392 -43477
+ Partials 1480 16 -1464 Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days. |
@rahulshendre can we get this to merge? |
✅ Deploy Preview for pipecd-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary
Updates the pipectl CLI documentation in
docs-devanddocs-v1.0.xto match the current source code.Changes
pipectl initfrom the "Available Commands" help output (command was removed in Remove pipectl init command #5958)completion,migrate, andpluginto the "Available Commands" help outputpipectl initcommandpipectl migrate application-configpipectl migrate databasepipectl plugin pushWhy we need it
pipectl initwas removed from the codebase but is still documented as an available command. Users following the official documentation currently hit a dead end.At the same time,
pipectl migrate(the replacement workflow) andpipectl plugin pushalready exist in the source code but are undocumented, making them difficult for users and plugin authors to discover.Which issue(s) this PR fixes
Closes: #6750
Does this PR introduce a user-facing change?
How are users affected by this change
CLI documentation now accurately reflects the currently available commands. Users can discover and use
pipectl migrateandpipectl plugin pushthrough the official docs.Is this a breaking change?
No
How to migrate (if breaking change)
N/A