✨(alpha update): add --git-config flag with clear defaults and replacement behavior #5017

camilamacedo86 · 2025-08-18T11:32:10Z

No description provided.

k8s-ci-robot · 2025-08-18T11:32:18Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [camilamacedo86]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

vitorfloriano · 2025-08-18T15:47:20Z

docs/book/src/reference/commands/alpha_update.md

+Keep built-in defaults (renameLimit tweaks) AND add more by repeating them explicitly
+
+```shell
+kubebuilder alpha update \
+  --git-config merge.renameLimit=999999 \
+  --git-config diff.renameLimit=999999 \
+  --git-config merge.conflictStyle=diff3 \
+  --git-config rerere.enabled=true
+```
+


@camilamacedo86 This section may mislead the user into thinking that those configs in the codeblock are the defaults. WDYT?

Good point I changed
Let me know wdyt now

camilamacedo86 · 2025-08-18T16:35:59Z

c/c @vitorfloriano could you please review this one?

vitorfloriano · 2025-08-18T22:32:14Z

docs/book/src/reference/commands/alpha_update.md

+| `--git-config`    | Repeatable. Pass per-invocation Git config as `-c key=value`. **Default** (if omitted): `-c merge.renameLimit=999999 -c diff.renameLimit=999999`. **Important**: if you pass this flag, your values **replace** the defaults. To keep them *and* add more, re-specify the defaults explicitly.  |
+| `-h, --help`      | Show help for this command.                                                                                                                                                                                                                                                                     |


Just to check that I understand this:

By default we set those two configs, right? If we pass any values to this flag, we won't have those two configs anymore, unless we re-add them along with the other configs we may pass.

Did I get it right?

I changed it a little to improve the UX
Give a look now in the docs changes and let me know wdyt?
See if you agree with for we get it merged

vitorfloriano · 2025-08-19T11:35:56Z

docs/book/src/reference/commands/alpha_update.md

+
+- **Disable defaults entirely**
+```shell
+kubebuilder alpha update --git-config disable


@camilamacedo86 What if we keep the default values UNLESS the user explicitly overrides them?

I think that would make the defaults more robust, if we believe the defaults are the way to go. But if the user disagrees, they can set THAT config as they wish.

Having three/four behaviors for this flag seems a bit confusing.

@camilamacedo86 What if we keep the default values UNLESS the user explicitly overrides them?

Yes

I think that would make the defaults more robust, if we believe the defaults are the way to go. But if the user disagrees, they can set THAT config as they wish.

Exactly.

Having three/four behaviors for this flag seems a bit confusing.

we have not inform : that has the default values

if set: then is default values + what is passed

if want to disable set : disable

I agree that is not simple
But it is an very advanaced feature so people will not tough unless they understand
I could not came with a better ux than that, if you have ideas please feel free to share

We could keep the defaults regardless of the user adding different configs (ex, conflictStyle=diff3 won't remove the defaults).

The defaults would only be changed if the user explicitly does so.

That way we wouldn't need the "disable" option, and we wouldn't need to add the defaults back in just because we want other, non-related, configs as well.

And, since the configs will only be set for those specific commands, I think we can be a bit more assertive/invasive about the configs we think are the best for what we are doing in kubebuilder alpha update.

We could keep the defaults regardless of the user adding different configs (ex, conflictStyle=diff3 won't remove the defaults).

that is how it is.

The defaults would only be changed if the user explicitly does so.
That is how it is.
The user must add "disable"

So, not sure if I follow your idea
But we must provide a option to allow the person opt-out besides we want ensure those by default

that is how it is.

I understood that:

There are two configs used by default

If the user passes any values to --git-config, the defaults will no longer apply, even if the values passed have nothing to do with the defaults.

If the user wants to pass values to --git-config AND keep the two defaults, the defaults need to be passed again.

If the user wants to disable the defaults, they can pass disable.

My suggestion was that:

There are two configs used by default

The defaults are kept even when the user passes other configs to --git-config.

The defaults are only overriden if the user passes different values to the same configs

Let me know if I got anything wrong.

If the user passes any values to --git-config, the defaults will no longer apply,

We changed that, see: https://github.com/kubernetes-sigs/kubebuilder/pull/5017/files#diff-3c12a0b0aee4383e0a39d64d93c5286c1f1b1384396e8fc067d284711ced078cR136

If --git-config is not set: Then we have the defaults

if --git-config is set: Then we have the defaults + values informed

if I want to disable the defaults then I need : --git-config disable and if I wish add others I append --git-config

camilamacedo86 · 2025-08-19T21:45:29Z

docs/book/src/reference/commands/alpha_update.md

+| `--preserve-path` | Repeatable. **Squash mode only.** After copying the merge tree to the output branch, restore these paths from the base branch (e.g., `.github/workflows`).                                                                                                                                      |
+| `--output-branch` | Name of the output branch. Default: `kubebuilder-update-from-<from-version>-to-<to-version>`.                                                                                                                                                                                                   |
+| `--push`          | Push the output branch to the `origin` remote after the update completes.                                                                                                                                                                                                                       |
+| `--git-config`    | Repeatable. Pass per-invocation Git config as `-c key=value`. **Default** (if omitted): `-c merge.renameLimit=999999 -c diff.renameLimit=999999`. **Important**: if you pass this flag, your values **replace** the defaults. To keep them *and* add more, re-specify the defaults explicitly.  |


Fix ^ Outdated

camilamacedo86 · 2025-08-19T21:47:47Z

docs/book/src/reference/commands/alpha_update.md

+| `--from-branch`   | Git branch that holds your current project code. Defaults to `main`.                                                                                                                                                                                                                            |
+| `--force`         | Continue even if merge conflicts happen. Conflicted files are committed with conflict markers (CI/cron friendly).                                                                                                                                                                               |
+| `--show-commits`  | Keep full history (do not squash). **Not compatible** with `--preserve-path`.                                                                                                                                                                                                                   |
+| `--preserve-path` | Repeatable. **Squash mode only.** After copying the merge tree to the output branch, restore these paths from the base branch (e.g., `.github/workflows`).                                                                                                                                      |


restore-path ^

docs/book/src/reference/commands/alpha_update.md

camilamacedo86 · 2025-08-20T11:36:18Z

Hi @vitorfloriano

I changed the the flag info in the doc.

vitorfloriano · 2025-08-20T12:30:23Z

/lgtm

Nice addition for advanced users.

k8s-ci-robot · 2025-08-20T12:30:27Z

@vitorfloriano: changing LGTM is restricted to collaborators

In response to this:

/lgtm

Nice addition for advanced users.

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.

…lacement behavior Assisted-by: ChatGPT (OpenAI) Co-authored-by: Vitor Floriano <vitorfloriano@users.noreply.github.com>

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 18, 2025

k8s-ci-robot requested review from Kavinjsir and varshaprasad96 August 18, 2025 11:32

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 18, 2025

camilamacedo86 force-pushed the add-git-config branch from 4c85725 to a4ae256 Compare August 18, 2025 11:40

vitorfloriano reviewed Aug 18, 2025

View reviewed changes

camilamacedo86 force-pushed the add-git-config branch from a4ae256 to aa48f76 Compare August 18, 2025 16:07

vitorfloriano reviewed Aug 18, 2025

View reviewed changes

camilamacedo86 force-pushed the add-git-config branch 2 times, most recently from 9b04ae3 to dc36149 Compare August 19, 2025 10:39

vitorfloriano reviewed Aug 19, 2025

View reviewed changes

camilamacedo86 requested a review from vitorfloriano August 19, 2025 19:26

camilamacedo86 commented Aug 19, 2025

View reviewed changes

docs/book/src/reference/commands/alpha_update.md Outdated Show resolved Hide resolved

camilamacedo86 force-pushed the add-git-config branch from dc36149 to 259004a Compare August 20, 2025 11:35

camilamacedo86 force-pushed the add-git-config branch from 259004a to 032373d Compare August 20, 2025 11:54

feat(alpha update): add --git-config flag with clear defaults and rep…

1b89844

…lacement behavior Assisted-by: ChatGPT (OpenAI) Co-authored-by: Vitor Floriano <vitorfloriano@users.noreply.github.com>

camilamacedo86 force-pushed the add-git-config branch from 032373d to 1b89844 Compare August 20, 2025 16:05

camilamacedo86 added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 20, 2025

k8s-ci-robot merged commit 92b2824 into kubernetes-sigs:master Aug 20, 2025
19 checks passed

vitorfloriano added this to GSoC 2025: Kubebuilder: Automating Operator Maintenance Aug 22, 2025

github-project-automation bot moved this to New in GSoC 2025: Kubebuilder: Automating Operator Maintenance Aug 22, 2025

camilamacedo86 mentioned this pull request Aug 25, 2025

Prepare release 4.8.0 #5052

Closed

		\| `--git-config` \| Repeatable. Pass per-invocation Git config as `-c key=value`. Default (if omitted): `-c merge.renameLimit=999999 -c diff.renameLimit=999999`. Important: if you pass this flag, your values replace the defaults. To keep them and add more, re-specify the defaults explicitly. \|
		\| `-h, --help` \| Show help for this command. \|

✨(alpha update): add --git-config flag with clear defaults and replacement behavior #5017

✨(alpha update): add --git-config flag with clear defaults and replacement behavior #5017

Uh oh!

Conversation

camilamacedo86 commented Aug 18, 2025

Uh oh!

k8s-ci-robot commented Aug 18, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

camilamacedo86 commented Aug 18, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vitorfloriano Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

camilamacedo86 Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

camilamacedo86 commented Aug 20, 2025

Uh oh!

vitorfloriano commented Aug 20, 2025

Uh oh!

k8s-ci-robot commented Aug 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vitorfloriano Aug 19, 2025 •

edited

Loading

camilamacedo86 Aug 19, 2025 •

edited

Loading