feat: add new commands for completion and migration in pipectl#6751
Open
vedantlavale wants to merge 1 commit intopipe-cd:masterfrom
Open
feat: add new commands for completion and migration in pipectl#6751vedantlavale wants to merge 1 commit intopipe-cd:masterfrom
vedantlavale wants to merge 1 commit intopipe-cd:masterfrom
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 |
|
|
||
| Available Commands: | ||
| application Manage application resources. | ||
| completion Generate the autocompletion script for the specified shell |
|
|
||
| Available Commands: | ||
| application Manage application resources. | ||
| completion Generate the autocompletion script for the specified shell |
| @@ -357,37 +359,54 @@ You can encrypt it the same way you do [from the web](../managing-application/se | |||
|
|
|||
| Note: The docs for pipectl available command is maybe outdated, we suggest users use the `help` command for the updated usage while using pipectl. | |||
| ### Generating an application config (app.pipecd.yaml) | ||
| ### Migrating application configs and database | ||
|
|
||
| Migrate v0 application configs and database records to be compatible with the plugin-based pipedv1. |
|
|
||
| #### Migrating database | ||
|
|
||
| Migrate database records to be compatible with plugin-architectured piped: |
Author
|
@khanhtc1202 , @rahulshendre , @Ayushmore1214 hey, could someone take a look at this when free? |
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
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.
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