Skip to content

chore(rbg): update v1alpha2 constants - #184

Merged
cheyang merged 2 commits into
sgl-project:mainfrom
Syspretor:chore/init-v1alpha2-constant
Mar 9, 2026
Merged

cheyang merged 2 commits into
sgl-project:mainfrom
Syspretor:chore/init-v1alpha2-constant

Conversation

@Syspretor

Copy link
Copy Markdown
Collaborator

Ⅰ. Motivation

Ⅱ. Modifications

Ⅲ. Does this pull request fix one issue?

fixes #XXXX

Ⅳ. List the added test cases (unit test/integration test) if any, please explain if no tests are needed.

Ⅴ. Describe how to verify it

VI. Special notes for reviews

Checklist

  • Format your code make fmt.
  • Add unit tests or integration tests.
  • Update the documentation related to the change.

@gemini-code-assist

Copy link
Copy Markdown

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 focuses on enhancing the clarity, organization, and future extensibility of API constants within the v1alpha2 version. By restructuring labels and annotations into distinct categories, introducing new enumeration types for key concepts, and providing utility functions for backward compatibility, the changes aim to improve the overall maintainability and robustness of the codebase without altering core functionality.

Highlights

  • Constant Refactoring and Renaming: The api/workloads/v1alpha2/constant.go file has undergone a significant refactoring. The ControllerName and RBGPrefix have been updated to shorter, more consistent values. All related labels and annotations have been reorganized into logical categories such as 'GroupSet level labels', 'Group level labels', 'Role level labels', 'RoleInstance level labels', 'Component level labels', and various annotation categories for Group, Role, RoleInstance, Lifecycle management, and InPlace updates. This improves clarity and maintainability.
  • New Enum Types Introduced: Several new enum types have been added to better define various states and patterns within the system. These include InstancePatternType (Stateless/Stateful), RoleTemplateType (Components/LeaderWorkerSet/PodTemplate), and LifecycleState (Normal, PreparingUpdate, Updating, Updated, PreparingDelete), providing more structured and explicit definitions for these concepts.
  • Backward Compatibility Helpers: Two new helper functions, GetLabelValue and GetAnnotationValue, have been introduced. These functions allow for retrieving label and annotation values with backward compatibility, checking for a new key first and falling back to an old key if the new one is not found. This ensures a smoother transition during the constant renaming.

🧠 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
  • api/workloads/v1alpha2/constant.go
    • Updated ControllerName from rolebasedgroup-controller to rbg-controller.
    • Modified RBGPrefix from rolebasedgroup.workloads.x-k8s.io/ to rbg.workloads.x-k8s.io/.
    • Refactored and renamed numerous label and annotation constants, organizing them under new logical sections like 'GroupSet level labels', 'Group level labels', 'Role level labels', 'RoleInstance level labels', 'Component level labels', 'Group level annotations', 'Role level annotations', 'RoleInstance level annotations', 'Lifecycle management annotations', and 'InPlace update annotations'.
    • Removed old prefix constants such as ComponentLabelPrefix, InstanceLabelPrefix, InstanceAnnotationPrefix, and RoleLabelPrefix.
    • Introduced new type definitions: InstancePatternType, RoleTemplateType, and LifecycleState, along with their respective constant values.
    • Added GetLabelValue and GetAnnotationValue helper functions for backward compatibility when retrieving label and annotation values.
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.

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

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

Copy link
Copy Markdown

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 refactors and cleans up the constants in api/workloads/v1alpha2/constant.go. The changes improve naming consistency and organization, which is a great improvement. I've identified a few areas for improvement: a potentially missing constant for the standalonePattern, some code duplication in the new helper functions, and a misleading comment. Overall, this is a good cleanup.

Comment thread api/workloads/v1alpha2/constant.go Outdated
Comment thread api/workloads/v1alpha2/constant.go Outdated
Comment thread api/workloads/v1alpha2/constant.go Outdated
@Syspretor
Syspretor force-pushed the chore/init-v1alpha2-constant branch from aa90c66 to 0cfae9a Compare March 9, 2026 09:16
Comment thread pkg/constants/common.go Outdated
Comment thread pkg/constants/common.go Outdated
@Syspretor
Syspretor force-pushed the chore/init-v1alpha2-constant branch from 9e40504 to 73067a1 Compare March 9, 2026 11:37

@cheyang cheyang left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

/lgtm
/approve

@cheyang
cheyang merged commit 7dfa457 into sgl-project:main Mar 9, 2026
7 of 8 checks passed
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.

2 participants