📖 improve docs of rescaffold #4479
Conversation
- name the default explicitly relates kubernetes-sigs#4478
k8s-ci-robot
added
do-not-merge/work-in-progress
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Sijoma The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
size/XS
|
Hi @Sijoma. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
| @@ -29,7 +29,7 @@ Currently, it supports two optional params, `input-dir` and `output-dir`. | |||
|
|
|||
| `input-dir` is the path to the existing project that you want to re-scaffold. Default is the current working directory. | |||
|
|
|||
| `output-dir` is the path to the directory where you want to generate the new project. Default is a subdirectory in the current working directory. | |||
| `output-dir` is the path to the directory where you want to generate the new project. Default is a directory named "output-dir" in the current working directory. | |||
There was a problem hiding this comment.
If we not inform the output-dir it should be == $pwd , the current directory.
Are you facing a different behaviour?
Does it create a directory called output-dir and scaffold the project inside of it?
There was a problem hiding this comment.
So that's the part that confused me.
The flag itself defaults to "" -> pkg/cli/alpha/command.go:59
The struct itself has a default then later here -> pkg/cli/alpha/internal/generate.go:46
It then sets it when this path is "" here as a default. -> pkg/cli/alpha/internal/generate.go:246
At least this is how I understand it and I get a output-dir folder.
There was a problem hiding this comment.
OH we need to fix that.
It is a bug. By default it should be current dir == PWD
There was a problem hiding this comment.
Just to get this right: So instead of appending output-dir to the PWD it should be just the PWD right?
I can make a PR for this & maybe this then also removes the need to change the docs.
There was a problem hiding this comment.
So something like this?
There was a problem hiding this comment.
We need to do a little more than that.
Also, we need to ensure it via the tests.
See: #4500
| @@ -39,7 +39,7 @@ kubebuilder alpha generate --input-dir=/path/to/existing/project --output-dir=/p | |||
| <h1>Regarding `input-dir` and `output-dir`:</h1> | |||
|
|
|||
| If neither `input-dir` nor `output-dir` are specified, the project will be regenerated in the current directory. | |||
| This approach facilitates comparison between your current local branch and the version stored upstream (e.g., GitHub main branch). | |||
| This approach facilitates comparison between your code and regenerated files in `output-dir`. | |||
So I was irritated by reading the documentation and also the CLI --help output.
I was surprised that the
output-diractually defaults tooutput-dir. I also did not understand how I could use git to diff the files with upstream if they are created in a sub directory. I would understand how this works if the files would be regenerated in place.I've adjusted the docs & command to be more explicit about the default value
output-dir.Furthermore, I've adjusted the note to explain that you can diff the local files against the
output-dir(the folder that was configured by the user).relates #4478