Skip to content

Commit 8090ded

Browse files
committed
(chore): adjust comments on Auto Update workflow
The comments for the `Run kubebuilder alpha update` step are now properly syntax-highlighted as such in yaml. The `--use-gh-models` flag is now properly referenced in the comments.
1 parent c3b0973 commit 8090ded

File tree

3 files changed

+21
-21
lines changed
  • docs/book/src/getting-started/testdata/project/.github/workflows
  • pkg/plugins/optional/autoupdate/v1alpha/scaffolds/internal/github
  • testdata/project-v4-with-plugins/.github/workflows

3 files changed

+21
-21
lines changed

docs/book/src/getting-started/testdata/project/.github/workflows/auto_update.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,14 @@ jobs:
5858
# Step 6: Run the Kubebuilder alpha update command.
5959
# More info: https://kubebuilder.io/reference/commands/alpha_update
6060
- name: Run kubebuilder alpha update
61+
# Executes the update command with specified flags.
62+
# --force: Completes the merge even if conflicts occur, leaving conflict markers.
63+
# --push: Automatically pushes the resulting output branch to the 'origin' remote.
64+
# --restore-path: Preserves specified paths (e.g., CI workflow files) when squashing.
65+
# --open-gh-issue: Creates a GitHub Issue with a link for opening a PR for review.
66+
# --use-gh-models: Adds an AI-generated comment to the created Issue with
67+
# a short overview of the scaffold changes and conflict-resolution guidance (If Any).
6168
run: |
62-
# Executes the update command with specified flags.
63-
# --force: Completes the merge even if conflicts occur, leaving conflict markers.
64-
# --push: Automatically pushes the resulting output branch to the 'origin' remote.
65-
# --restore-path: Preserves specified paths (e.g., CI workflow files) when squashing.
66-
# --open-gh-issue: Creates a GitHub Issue with a link for opening a PR for review.
67-
# --open-gh-models: Adds an AI-generated comment to the created Issue with
68-
# a short overview of the scaffold changes and conflict-resolution guidance (If Any).
6969
kubebuilder alpha update \
7070
--force \
7171
--push \

pkg/plugins/optional/autoupdate/v1alpha/scaffolds/internal/github/auto_update.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,14 @@ jobs:
102102
# Step 6: Run the Kubebuilder alpha update command.
103103
# More info: https://kubebuilder.io/reference/commands/alpha_update
104104
- name: Run kubebuilder alpha update
105+
# Executes the update command with specified flags.
106+
# --force: Completes the merge even if conflicts occur, leaving conflict markers.
107+
# --push: Automatically pushes the resulting output branch to the 'origin' remote.
108+
# --restore-path: Preserves specified paths (e.g., CI workflow files) when squashing.
109+
# --open-gh-issue: Creates a GitHub Issue with a link for opening a PR for review.
110+
# --use-gh-models: Adds an AI-generated comment to the created Issue with
111+
# a short overview of the scaffold changes and conflict-resolution guidance (If Any).
105112
run: |
106-
# Executes the update command with specified flags.
107-
# --force: Completes the merge even if conflicts occur, leaving conflict markers.
108-
# --push: Automatically pushes the resulting output branch to the 'origin' remote.
109-
# --restore-path: Preserves specified paths (e.g., CI workflow files) when squashing.
110-
# --open-gh-issue: Creates a GitHub Issue with a link for opening a PR for review.
111-
# --open-gh-models: Adds an AI-generated comment to the created Issue with
112-
# a short overview of the scaffold changes and conflict-resolution guidance (If Any).
113113
kubebuilder alpha update \
114114
--force \
115115
--push \

testdata/project-v4-with-plugins/.github/workflows/auto_update.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,14 @@ jobs:
5858
# Step 6: Run the Kubebuilder alpha update command.
5959
# More info: https://kubebuilder.io/reference/commands/alpha_update
6060
- name: Run kubebuilder alpha update
61+
# Executes the update command with specified flags.
62+
# --force: Completes the merge even if conflicts occur, leaving conflict markers.
63+
# --push: Automatically pushes the resulting output branch to the 'origin' remote.
64+
# --restore-path: Preserves specified paths (e.g., CI workflow files) when squashing.
65+
# --open-gh-issue: Creates a GitHub Issue with a link for opening a PR for review.
66+
# --use-gh-models: Adds an AI-generated comment to the created Issue with
67+
# a short overview of the scaffold changes and conflict-resolution guidance (If Any).
6168
run: |
62-
# Executes the update command with specified flags.
63-
# --force: Completes the merge even if conflicts occur, leaving conflict markers.
64-
# --push: Automatically pushes the resulting output branch to the 'origin' remote.
65-
# --restore-path: Preserves specified paths (e.g., CI workflow files) when squashing.
66-
# --open-gh-issue: Creates a GitHub Issue with a link for opening a PR for review.
67-
# --open-gh-models: Adds an AI-generated comment to the created Issue with
68-
# a short overview of the scaffold changes and conflict-resolution guidance (If Any).
6969
kubebuilder alpha update \
7070
--force \
7171
--push \

0 commit comments

Comments
 (0)