add more contents to build procedure page for kubeedge. by fujitatomoya · Pull Request #760 · kubeedge/website

fujitatomoya · 2026-02-06T03:52:54Z

Please check if the PR fulfills these requirements

The commit message follows our guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

Which issue(s) this PR fixes:

Closes #759

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Build procedure documentation quality enhancement

What is the current behavior? (You can also link to an open issue here)

Out of dated, not well enough described.

What is the new behavior (if this is a feature change)?

Up to date with current Makefile from KubeEdge

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

No

Other information:

None

Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>

kubeedge-bot · 2026-02-06T03:53:01Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign fisherxu after the PR has been reviewed.
You can assign the PR to them by writing /assign @fisherxu in a comment when ready.

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

Details

Needs approval from an approver in each of these files:

OWNERS

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

gemini-code-assist · 2026-02-06T03:53:11Z

Summary of Changes

Hello @fujitatomoya, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the KubeEdge build procedure documentation. It provides comprehensive and up-to-date instructions for developers, covering prerequisites, various build configurations (including component-specific, cross-platform, and optimized builds), a full suite of testing procedures (linting, verification, unit, integration, and E2E tests), installation steps, and release processes. The update aims to align the documentation with the current KubeEdge Makefile, making it more accurate and user-friendly.

Highlights

Prerequisites Update: Added yq command-line YAML processor as a new prerequisite, including installation instructions for Linux.
Expanded Build Instructions: Detailed how to build specific KubeEdge components using the WHAT parameter, perform cross-platform builds, create optimized small builds for resource-limited devices, and clean build artifacts.
Comprehensive Testing Guide: Introduced detailed instructions for linting (with component-specific options), verifying code quality (including Go version, vendor dependencies, code generation, licenses, and CRDs), running unit tests (with component-specific options and coverage profile generation), and executing integration and E2E tests (including keadm specific E2E tests).
New Operational Sections: Added dedicated sections for installing built binaries to the system or custom paths, and for creating release packages for KubeEdge components.
DMI Protobuf Generation: Included instructions for generating Device Management Interface (DMI) API protobuf files for default or specific versions.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

docs/developer/build.md
- Added yq as a prerequisite, including installation commands for Linux.
- Expanded the "Compiling kubeedge" section with commands for building specific components (WHAT parameter), cross-platform builds (crossbuild), small builds (smallbuild), and cleaning build artifacts (clean).
- Revamped the "Running tests" section to include lint (with WHAT parameter), verify (detailing sub-checks like verify-golang, verify-vendor, verify-codegen, verify-vendor-licenses, verify-crds), test (with WHAT parameter and PROFILE=y for coverage), integrationtest (with execution steps), and e2e (including keadm_e2e and keadm_deprecated_e2e).
- Introduced new top-level sections: "Installation" (for installing binaries to system or custom paths) and "Release" (for creating release packages for components).
- Added an "Additional targets" section, specifically for generating DMI protobuf files (dmi-proto).

Activity

The pull request addresses and closes issue Build page does not describe enough about targets and required package to be installed. #759 on the kubeedge/website repository.
It is categorized as a "Build procedure documentation quality enhancement".
The author states the PR updates outdated and insufficiently described documentation to be "Up to date with current Makefile from KubeEdge".
No breaking changes are introduced by this PR.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request significantly improves the build procedure documentation by adding detailed explanations and examples for various make targets. The new structure is much clearer and more comprehensive. I have a couple of suggestions to further improve clarity and prevent potential user errors, mainly regarding prerequisite installation and consistency in build commands.

gemini-code-assist · 2026-02-06T03:54:28Z

docs/developer/build.md

+```bash
+# Download and install the latest yq binary (platform-specific)
+# For Linux (amd64)
+wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/local/bin/yq && chmod +x /usr/local/bin/yq


This command will likely fail due to permission errors since it writes to /usr/local/bin. It's better to prepend sudo to both wget and chmod to avoid this.

Additionally, for macOS users, it would be clearer to recommend installing yq via Homebrew (brew install yq) alongside the other tools, rather than pointing them to this manual installation section.

Suggested change

wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/local/bin/yq && chmod +x /usr/local/bin/yq

sudo wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/local/bin/yq && sudo chmod +x /usr/local/bin/yq

gemini-code-assist · 2026-02-06T03:54:28Z

docs/developer/build.md

+Build all KubeEdge binaries:
+
 ```bash
 make


For consistency with the subsequent examples that use make all WHAT=..., it would be clearer to use make all here as well to build all binaries. This avoids potential confusion about whether make and make all are equivalent.

Suggested change

make

make all

fujitatomoya

@Shelley-BaoYue can you have a quick look at this? this is just straight-forward enhancement aligned with current https://github.com/kubeedge/kubeedge/blob/master/Makefile

fujitatomoya · 2026-02-06T03:55:28Z

@Shelley-BaoYue btw, who is the active reviewer or maintainer to monitor this repository?

Shelley-BaoYue · 2026-02-10T07:21:11Z

docs/developer/build.md

@@ -6,13 +6,24 @@ sidebar_position: 1
 ## Prerequisites

 * A recent Go distribution (>=1.16)


Suggested change

* A recent Go distribution (>=1.16)

* A recent Go distribution (>=1.21)

go version can also be updated : )

Shelley-BaoYue · 2026-02-10T08:10:39Z

@Shelley-BaoYue btw, who is the active reviewer or maintainer to monitor this repository?

Recently, seems only me 😢

add more contents to build procedure page for kubeedge.

c3f81df

Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>

kubeedge-bot requested review from Shelley-BaoYue and wbc6080 February 6, 2026 03:52

kubeedge-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 6, 2026

gemini-code-assist bot reviewed Feb 6, 2026

View reviewed changes

fujitatomoya commented Feb 6, 2026

View reviewed changes

Shelley-BaoYue reviewed Feb 10, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add more contents to build procedure page for kubeedge.#760

add more contents to build procedure page for kubeedge.#760
fujitatomoya wants to merge 1 commit intokubeedge:masterfrom
fujitatomoya:issues/759

fujitatomoya commented Feb 6, 2026 •

edited

Loading

Uh oh!

kubeedge-bot commented Feb 6, 2026

Uh oh!

gemini-code-assist bot commented Feb 6, 2026

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Feb 6, 2026

Uh oh!

gemini-code-assist bot Feb 6, 2026

Uh oh!

fujitatomoya left a comment

Uh oh!

fujitatomoya commented Feb 6, 2026

Uh oh!

Shelley-BaoYue Feb 10, 2026

Uh oh!

Shelley-BaoYue commented Feb 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/local/bin/yq && chmod +x /usr/local/bin/yq
	sudo wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/local/bin/yq && sudo chmod +x /usr/local/bin/yq

		@@ -6,13 +6,24 @@ sidebar_position: 1
		## Prerequisites

		* A recent Go distribution (>=1.16)

	* A recent Go distribution (>=1.16)
	* A recent Go distribution (>=1.21)

Conversation

fujitatomoya commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kubeedge-bot commented Feb 6, 2026

Uh oh!

gemini-code-assist bot commented Feb 6, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

fujitatomoya left a comment

Choose a reason for hiding this comment

Uh oh!

fujitatomoya commented Feb 6, 2026

Uh oh!

Shelley-BaoYue Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Shelley-BaoYue commented Feb 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fujitatomoya commented Feb 6, 2026 •

edited

Loading