feat: adopt zbuild #39
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ensi321, 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 introduces zbuild as the new build system for the project. The change involves replacing the existing manual build.zig and build.zig.zon files with versions that are automatically generated by zbuild. A new zbuild.zon file is added to serve as the declarative configuration for all build artifacts, including executables, libraries, and tests. This adoption aims to streamline the build process and centralize build definitions.
Highlights
- Migration to zbuild: The project's build system has been migrated to use
zbuild, a new build tool for Zig projects. - Automated Build Script Generation: The
build.zigfile is now automatically generated byzbuildbased on the newzbuild.zonconfiguration, replacing the previous manually maintained script. - New zbuild.zon Configuration File: A new
zbuild.zonfile has been introduced to centralize the definition of executables, libraries, and tests, serving as the primary configuration for thezbuildsystem.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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.
Footnotes
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request migrates the project's build system to use zbuild, which involves adding a zbuild.zon configuration file and auto-generating build.zig and build.zig.zon. The migration looks good overall, but I have a few suggestions for the configuration files to improve clarity, correctness, and adhere to best practices. My main points are to rename the executable for better description, remove redundant test definitions that cause tests to run twice, and restore an important security-related comment in the package manifest.
| .options_modules = .{}, | ||
| .modules = .{}, | ||
| .executables = .{ | ||
| .main = .{ |
There was a problem hiding this comment.
The executable is currently named main, which is not very descriptive. The previous build.zig script named the executable state-transition, which seems more appropriate given the project's name. Consider renaming main to state_transition for clarity.
.state_transition = .{
There was a problem hiding this comment.
There is a naming conflict between this and .libraries.state-transition because zbuild will define module for each executable and library. So having state-transition in executables and libraries will generate a build.zig with naming conflict
Performance Report✔️ no performance regression detected Full benchmark results
|
There was a problem hiding this comment.
lgtm as far as a port of what's already there.
I suppose most of the work is on other branches, but immediate things I see:
- ssz-z isn't a dependency?
- why is there an executable?
- the state transition should be exported as a module, not a library
- any bun-ffi binding library should consume the state transition module
2 participants
No description provided.