Skip to content

chore: add check for yaml lint#238

Merged
cheyang merged 2 commits intosgl-project:mainfrom
Syspretor:ch0re/add-check-for-yaml-lint
Mar 24, 2026
Merged

chore: add check for yaml lint#238
cheyang merged 2 commits intosgl-project:mainfrom
Syspretor:ch0re/add-check-for-yaml-lint

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 introduces YAML linting to the project. By adding a .yamllint.yml configuration file, the project aims to enforce consistent formatting, identify potential syntax errors, and improve the overall quality and maintainability of YAML files, particularly those related to Kubernetes configurations.

Highlights

  • YAML Linting Configuration: Introduced a new .yamllint.yml file to define rules and ignore patterns for YAML linting, ensuring consistent formatting and error detection in YAML files across the project.

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

Ignored Files
  • Ignored by pattern: .github/workflows/** (1)
    • .github/workflows/project-check.yml
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
Copy Markdown

@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 introduces a .yamllint.yml configuration file to enforce consistent styling for YAML files within the repository. The configuration correctly extends the default rules and ignores generated CRD files. I have provided a couple of suggestions to improve the consistency of the linting rules themselves, which will enhance the maintainability of your YAML files.

Comment thread .yamllint.yml
Comment thread .yamllint.yml
@Syspretor Syspretor force-pushed the ch0re/add-check-for-yaml-lint branch 2 times, most recently from c1b5e77 to 8349b3c Compare March 23, 2026 09:40
@Syspretor Syspretor force-pushed the ch0re/add-check-for-yaml-lint branch from 8349b3c to b65f498 Compare March 23, 2026 09:45
Copy link
Copy Markdown
Collaborator

@cheyang cheyang left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@cheyang cheyang self-requested a review March 23, 2026 11:10

- name: YAML lint check
run: |
pip install yamllint
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.

Non-blocking thought: it may be worth pinning the yamllint version here. Installing the latest version keeps setup simple, but it can also make CI behavior drift over time if lint rules change upstream.

Copy link
Copy Markdown
Collaborator

@cheyang cheyang left a comment

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 36077b1 into sgl-project:main Mar 24, 2026
9 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