Conversation
dosubot
bot
requested review from
efiacor,
kispaljr,
liamfallon and
mozesl-nokia
as code owners
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
dosubot
bot
added
size:M
|
This auto-generated PR contains documentation changes for PRs not merged yet: ie #4411 |
|
Please resolve the conflicts |
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
There was a problem hiding this comment.
Pull request overview
This PR updates documentation to reflect the new auto-create directory feature introduced in PR #4405, which enables kpt pkg init to automatically create package directories.
Changes:
- Updated documentation examples to remove manual
mkdirsteps beforekpt pkg init - Clarified CI best practices regarding when not to use
kpt pkg init - Added example output showing the directory creation message
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
local-config/_index.md |
Updated example to use kpt pkg init my-pkg instead of mkdir + kpt pkg init workflow |
depends-on/_index.md |
Updated example to use kpt pkg init my-pkg instead of mkdir + kpt pkg init workflow |
apply-time-mutation/_index.md |
Updated example to use kpt pkg init my-pkg instead of mkdir + kpt pkg init workflow |
migration.md |
Updated migration guide description (note: contains trailing whitespace) |
namespace-provisioning-cli.md |
Updated guide with new workflow and example output showing directory creation |
08-ci-user-guide/_index.md |
Clarified anti-pattern to specify not creating package metadata in CI |
03-packages/_index.md |
Contains unresolved merge conflicts between two versions describing package creation |
02-concepts/_index.md |
Contains unresolved merge conflicts in Kptfile Annotations section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <<<<<<< HEAD | ||
| Creating a new package is simple. Use the `pkg init` command to initialize a directory as a kpt package with a minimal `Kptfile` and `README` files: | ||
| ======= | ||
| Creating a new package is simple. Use the `pkg init` command to create a package directory with a minimal `Kptfile` and `README` files: | ||
| >>>>>>> main | ||
|
|
||
| ```shell | ||
| kpt pkg init awesomeapp | ||
| ``` | ||
|
|
||
| <<<<<<< HEAD | ||
| The command will automatically create the `awesomeapp` directory if it doesn't exist, eliminating the need to manually create the directory beforehand. | ||
| ======= | ||
| This will create the `awesomeapp` directory if it doesn't exist, and initialize it with the necessary files. | ||
| >>>>>>> main |
There was a problem hiding this comment.
This file contains unresolved merge conflict markers (<<<<<<< HEAD, =======, >>>>>>> main). These must be resolved before the PR can be merged. The conflict appears to be between two slightly different phrasings of the same concept - one says "initialize a directory as a kpt package" while the other says "create a package directory". Choose one version and remove the conflict markers.
| <<<<<<< HEAD | ||
| The Kptfile supports annotations that control package-level behavior: | ||
|
|
||
| - **`kpt.dev/bfs-rendering`**: When set to `"true"`, renders the package hierarchy in breadth-first order instead of the default depth-first post-order. | ||
| - **`kpt.dev/save-on-render-failure`**: When set to `"true"`, saves partially rendered resources to disk even when rendering fails, instead of reverting all changes. This is particularly useful for debugging render failures and is essential for programmatic package rendering scenarios (e.g., Porch integration) where preserving partial progress is valuable. | ||
| ======= | ||
| The Kptfile supports annotations that control package-level behaviour: | ||
|
|
||
| - **`kpt.dev/bfs-rendering`**: When set to `"true"`, renders the package hierarchy in breadth-first order instead of | ||
| the default depth-first post-order. | ||
| - **`kpt.dev/save-on-render-failure`**: When set to `"true"`, saves partially rendered resources to disk even when | ||
| rendering fails, instead of reverting all changes. This is particularly useful for debugging render failures and is | ||
| essential for programmatic package rendering scenarios where preserving partial progress is valuable. | ||
| >>>>>>> main |
There was a problem hiding this comment.
This file contains unresolved merge conflict markers (<<<<<<< HEAD, =======, >>>>>>> main). These must be resolved before the PR can be merged. The conflict is in the Kptfile Annotations section where there are two versions with slightly different formatting (one has single-line descriptions vs. multi-line descriptions). Choose one version and remove the conflict markers.
| | ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `kpt pkg get REPO_URI[.git]/PKG_PATH[@VERSION] LOCAL_DEST_DIRECTORY [flags]` | `kpt pkg get REPO_URI[.git]/PKG_PATH[@VERSION] [flags] [LOCAL_DEST_DIRECTORY]` <br> Fetch a remote package from a git subdirectory and writes it to a new local directory. | | ||
| | `kpt pkg init DIR [flags]` | `kpt pkg init [DIR] [flags]` <br> Initializes a directory as a kpt package by adding a Kptfile. Creates the directory if it does not exist. | | ||
| | `kpt pkg init DIR [flags]` | `kpt pkg init [DIR] [flags]` <br> Initializes a directory as a kpt package by adding a Kptfile. Creates the directory if it does not exist. | |
There was a problem hiding this comment.
This line appears to have unnecessary trailing whitespace added. While this doesn't affect functionality, it's generally a good practice to avoid trailing whitespace in documentation files to keep the source clean.
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Update documentation for #4405
Generated by Dosu