Skip to content

AGENTS: add build instructions#30826

Open
jaki wants to merge 5 commits intoyugabyte:masterfrom
jaki:agents-build-instructions
Open

AGENTS: add build instructions#30826
jaki wants to merge 5 commits intoyugabyte:masterfrom
jaki:agents-build-instructions

Conversation

@jaki
Copy link
Contributor

@jaki jaki commented Mar 26, 2026

Add coredb build instructions to src/AGENTS.md.


Note

Low Risk
Low risk because this PR only updates developer documentation and does not change any product or build scripts. The main risk is minor confusion if the suggested flags/targets become outdated.

Overview
Updates src/AGENTS.md with expanded CoreDB build guidance: recommends reusing the existing build type via build/latest, documents common yb_build.sh flags to speed incremental builds, and lists incremental-build pitfalls.

Adds refreshed example commands (including ASAN + reinitdb) and links to the (potentially stale) build-and-test docs page for more details.

Written by Cursor Bugbot for commit af84f3d. This will update automatically on new commits. Configure here.

@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 enhances the src/AGENTS.md documentation by providing updated and more comprehensive instructions for building coredb. The changes aim to guide developers in optimizing build times and avoiding common issues during incremental builds, ensuring a smoother development workflow.

Highlights

  • Updated Build Instructions: Revised the yb_build.sh usage recommendations to include options for reusing existing build types and reducing build times.
  • Incremental Build Pitfalls: Documented common issues and considerations when performing incremental builds, such as initdb and reinitdb usage.
  • New Build Command Examples: Added updated examples for common build commands, including asan reinitdb and a comprehensive release build with various optimizations.

🧠 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.

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.

Footnotes

  1. 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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the AGENTS.md documentation to provide clearer build instructions and tips. It includes guidance on reusing existing build configurations, options to reduce build time, and common pitfalls during incremental builds. A suggestion was made to improve the clarity of the documentation regarding the initdb cmake target when used with test options.

./yb_build.sh release initdb
```
Pitfalls when doing incremental build:
- `initdb` cmake target in conjunction with `yb_build.sh` test options may not build `initdb`, so in that case, do them one by one.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrase "do them one by one" is a bit ambiguous. For better clarity, it would be helpful to be more explicit about the separate steps required. For example, you could suggest building initdb first and then running tests in a separate command.

Suggested change
- `initdb` cmake target in conjunction with `yb_build.sh` test options may not build `initdb`, so in that case, do them one by one.
- The `initdb` cmake target may not be built when specified in the same `yb_build.sh` command as test options. In this case, build `initdb` first in a separate command before running tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant