Skip to content

Commit

Permalink
🌱 improve docs of rescaffold
Browse files Browse the repository at this point in the history
- name the default explicitly

relates kubernetes-sigs#4478
  • Loading branch information
Sijoma committed Jan 9, 2025
1 parent 458615a commit 2ea6836
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/book/src/reference/rescaffold.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

```sh
kubebuilder alpha generate --input-dir=/path/to/existing/project --output-dir=/path/to/new/project
Expand All @@ -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`.
This way, you can easily overlay your project's code changes atop the new scaffold.

</aside>
Expand All @@ -50,4 +50,4 @@ This way, you can easily overlay your project's code changes atop the new scaffo
- See the [desing proposal documentation](../../../../designs/helper_to_upgrade_projects_by_rescaffolding.md)

[example]: ./../../../../testdata/project-v4-with-plugins/PROJECT
[more-info]: ./../reference/project-config.md
[more-info]: ./../reference/project-config.md
3 changes: 2 additions & 1 deletion pkg/cli/alpha/command.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ package alpha
import (
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"

"sigs.k8s.io/kubebuilder/v4/pkg/cli/alpha/internal"
)

Expand Down Expand Up @@ -57,7 +58,7 @@ Then we will re-scaffold the project by Kubebuilder in the directory specified b
scaffoldCmd.Flags().StringVar(&opts.InputDir, "input-dir", "",
"path to a Kubebuilder project file if not in the current working directory")
scaffoldCmd.Flags().StringVar(&opts.OutputDir, "output-dir", "",
"path to output the scaffolding. defaults a directory in the current working directory")
"path to output the scaffolding. defaults to a directory named `output-dir` in the current working directory")

return scaffoldCmd
}

0 comments on commit 2ea6836

Please sign in to comment.