✨ Add plugin for Alpha Update Command #5027

camilamacedo86 · 2025-08-20T14:23:27Z

Adds an optional plugin that scaffolds a GitHub Actions workflow to keep projects aligned with the latest Kubebuilder scaffold. The workflow runs kubebuilder alpha update (3-way merge), pushes an update branch, and opens a GitHub Issue with a compare link so maintainers can open a PR and review safely.

k8s-ci-robot · 2025-08-20T14:23:34Z

[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

camilamacedo86 · 2025-08-20T17:14:01Z

docs/book/src/plugins/available/autoupdate-v1-alpha.md

+Then, whenever a new Kubebuilder release is available, it will open an Issue with a
+Pull Request compare link so you can create the PR and review it, such as:
+
+<TODO ISSUE ADD IMAGE>


@vitorfloriano it would be nice we add an image of the issue here

i could test it out and mock for what we want to show :-)

Did you edit it?

camilamacedo86 · 2025-08-20T17:17:52Z

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

@@ -0,0 +1,66 @@
+name: Alpha Update


@vitorfloriano here is out final result :-)

We need to fix for Auto Update
doing now

pkg/plugins/optional/autoupdate/v1alpha/plugin.go

vitorfloriano · 2025-08-20T22:56:15Z

docs/book/src/plugins/available/autoupdate-v1-alpha.md

+Run:
+
+```
+kubebuilder init|edit --plugins="autoupdate.kubebuilder.io/v1-alpha"


@camilamacedo86 I noticed that passing a value to --plugins when initiating the project overrides the other plugins. Should we add a note about that or should we change the behavior to be additive?

No, because the plugins behvaiour is the same for all plugins
So, we do not need to doc how plugins chain work here.
Otherwise, we would replicate this info in each plugin doc
How plugin work is doc already: https://book.kubebuilder.io/plugins/plugins

Then maybe we could add this link to the docs somewhere in this section, just so users can learn more about how to work with plugins in Kubebuilder. WDYT?

I would advocate for we do not because it is something that is == with all cases
I would prefer change the example
add one with init and go/v4 and other with edit
I will do it.

@vitorfloriano see now if it address your concerns
I think now is much more clear.

If all is OK for you let us know by LGTM so we can get this one merged

It's much better now.

docs/book/src/plugins/available/autoupdate-v1-alpha.md

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

pkg/plugins/optional/autoupdate/v1alpha/plugin.go

test/e2e/alphagenerate/generate_test.go

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

vitorfloriano · 2025-08-21T00:16:03Z

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

+	# Step 1: Checkout the repository.
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        token: {{ "${{ secrets.GITHUB_TOKEN }}" }}
+        fetch-depth: 0
+    
+	# Step 2: Configure Git to create commits with the GitHub Actions bot.
+    - name: Configure Git
+      run: |
+        git config --global user.name "github-actions[bot]"
+        git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+    # Step 3: Set up Go environment.
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: stable
+
+	# Step 4: Install Kubebuilder.
+    - name: Install Kubebuilder
+      run: |
+        curl -L -o kubebuilder "https://go.kubebuilder.io/dl/latest/$(go env GOOS)/$(go env GOARCH)"
+        chmod +x kubebuilder
+        sudo mv kubebuilder /usr/local/bin/
+        kubebuilder version
+
+	# Step 5: Run the Kubebuilder alpha update command.
+	# More info: https://kubebuilder.io/reference/commands/alpha_update
+    - name: Run kubebuilder alpha update
+      run: |
+		# Executes the update command with specified flags.
+		# --force: Completes the merge even if conflicts occur, leaving conflict markers.
+		# --push: Automatically pushes the resulting output branch to the 'origin' remote.
+		# --restore-path: Preserves specified paths (e.g., CI workflow files) when squashing.
+		# --open-gh-issue: Creates a GitHub issue with a link to the generated PR for review.
+        kubebuilder alpha update \
+          --force \
+          --push \
+          --restore-path .github/workflows \
+          --open-gh-issue
+`


In the template, it seems that some of the comments were indented using tabs. We should not use tabs, as the YAML specs recommend.

You acctully discover a bug
We have a linter to verify that: #5030

Co-authored-by: Vitor Floriano <[email protected]>

vitorfloriano · 2025-08-21T17:58:52Z

LGTM.

This plugin correctly scaffolds the update workflow when passed to --plugins in init and edit routines.

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Aug 20, 2025

k8s-ci-robot requested review from Kavinjsir and varshaprasad96 August 20, 2025 14:23

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 20, 2025

camilamacedo86 changed the title ~~✨ Add plugin for Alpha Update~~ WIP (missing doc)✨ Add plugin for Alpha Update Aug 20, 2025

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 20, 2025

camilamacedo86 force-pushed the docs-alpha-update branch from d0923b6 to 05a090c Compare August 20, 2025 17:05

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 20, 2025

camilamacedo86 changed the title ~~WIP (missing doc)✨ Add plugin for Alpha Update~~ ✨ Add plugin for Alpha Update Aug 20, 2025

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 20, 2025

camilamacedo86 force-pushed the docs-alpha-update branch from 05a090c to c59be43 Compare August 20, 2025 17:10

camilamacedo86 commented Aug 20, 2025

View reviewed changes

vitorfloriano reviewed Aug 20, 2025

View reviewed changes

pkg/plugins/optional/autoupdate/v1alpha/plugin.go Show resolved Hide resolved

camilamacedo86 force-pushed the docs-alpha-update branch from c59be43 to bfd5dcd Compare August 20, 2025 20:08

camilamacedo86 requested a review from vitorfloriano August 20, 2025 21:31

vitorfloriano reviewed Aug 20, 2025

View reviewed changes

vitorfloriano reviewed Aug 21, 2025

View reviewed changes

camilamacedo86 force-pushed the docs-alpha-update branch from bfd5dcd to 1c064b2 Compare August 21, 2025 08:58

camilamacedo86 changed the title ~~✨ Add plugin for Alpha Update~~ ✨ Add plugin for Alpha Update Command Aug 21, 2025

camilamacedo86 force-pushed the docs-alpha-update branch 4 times, most recently from 62356f1 to 1956885 Compare August 21, 2025 11:52

camilamacedo86 requested a review from vitorfloriano August 21, 2025 12:30

(chore): Add plugin for Alpha Update

2697198

Co-authored-by: Vitor Floriano <[email protected]>

camilamacedo86 force-pushed the docs-alpha-update branch from 1956885 to 2697198 Compare August 21, 2025 13:18

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

k8s-ci-robot merged commit 9b9b397 into kubernetes-sigs:master Aug 21, 2025
30 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

✨ Add plugin for Alpha Update Command #5027

✨ Add plugin for Alpha Update Command #5027

Uh oh!

Conversation

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

Uh oh!

Uh oh!

k8s-ci-robot commented Aug 20, 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!

Choose a reason for hiding this comment

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vitorfloriano commented Aug 21, 2025

Uh oh!

Uh oh!

Uh oh!

camilamacedo86 commented Aug 20, 2025 •

edited

Loading