Skip to content

Commit 124673c

Browse files
authored
Merge pull request #5429 from camilamacedo86/add-flag
✨ (alpha/update): add flags for custom commit messages
2 parents 8433d9b + 41b83a1 commit 124673c

File tree

5 files changed

+234
-2
lines changed

5 files changed

+234
-2
lines changed

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

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ The command creates three temporary branches:
6464
- `--show-commits`: keep the full history.
6565
- `--restore-path`: in squash mode, restore specific files (like CI configs) from your base branch.
6666
- `--output-branch`: pick a custom branch name.
67+
- `--commit-message`: customize the commit message for clean merges.
68+
- `--commit-message-conflict`: customize the commit message when conflicts occur.
6769
- `--push`: push the result to `origin` automatically.
6870
- `--git-config`: sets git configurations.
6971
- `--open-gh-issue`: create a GitHub issue with a checklist and compare link (requires `gh`).
@@ -121,6 +123,14 @@ Run update and push the result to origin:
121123
kubebuilder alpha update --from-version v4.6.0 --to-version v4.7.0 --force --push
122124
```
123125

126+
Customize commit messages:
127+
128+
```shell
129+
kubebuilder alpha update --force \
130+
--commit-message "chore: upgrade kubebuilder scaffold" \
131+
--commit-message-conflict "chore: upgrade with conflicts - manual review needed"
132+
```
133+
124134
## Handling Conflicts (`--force` vs default)
125135

126136
When you use `--force`, Git finishes the merge even if there are conflicts.
@@ -223,8 +233,10 @@ We use that value to pick the correct CLI for re-scaffolding.
223233

224234
## Flags
225235

226-
| Flag | Description |
227-
|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
236+
| Flag | Description |
237+
|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
238+
| `--commit-message` | Custom commit message for successful merges (no conflicts). Defaults to `chore(kubebuilder): update scaffold <from> -> <to>`. |
239+
| `--commit-message-conflict` | Custom commit message for merges with conflicts. Defaults to `:warning: chore(kubebuilder): update scaffold (manual conflict resolution) <from> -> <to>`. |
228240
| `--force` | Continue even if merge conflicts happen. Conflicted files are committed with conflict markers (CI/cron friendly). |
229241
| `--from-branch` | Git branch that holds your current project code. Defaults to `main`. |
230242
| `--from-version` | Kubebuilder release to update **from** (e.g., `v4.6.0`). If unset, read from the `PROJECT` file when possible. |

0 commit comments

Comments
 (0)