chore(ci): enforce settings docs parity in preflight

[LyalinDotCom]

Summary

• add check:docs:settings to run settings docs verification locally
• include settings docs verification in preflight to catch CI-only failures earlier
• update GEMINI.md testing guidance with explicit CI-parity checks for CLI/UI changes

Testing

• npm run check:docs:settings (fails in this environment due to missing local dependency: tsc)

[gemini-code-assist]

Summary of Changes

Hello @LyalinDotCom, 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 enhances the development workflow by integrating settings documentation verification into the preflight checks and providing a dedicated local script for this purpose. The changes aim to ensure documentation consistency and catch potential issues related to settings documentation earlier, improving overall code quality and developer experience by aligning local and CI checks.

Highlights

• New check:docs:settings script: A new npm script, check:docs:settings, has been introduced to verify settings documentation locally. This script first builds the @google/gemini-cli-core workspace and then runs the settings documentation generation with a --check flag.
• Settings docs verification in preflight: The preflight script now includes the check:docs:settings command, ensuring that settings documentation parity is verified as part of the standard pre-commit checks. This helps catch CI-only failures earlier in the development cycle.
• Updated GEMINI.md guidance: The GEMINI.md file has been updated to reflect the inclusion of settings docs verification in preflight and to explicitly list CI-parity checks for CLI/UI changes, including npm run test:ci --workspace @google/gemini-cli and npm run check:docs:settings.

Changelog

• GEMINI.md
  • Updated the description of the preflight command to include 'settings docs verification'.
  • Added a new section for 'CI-Parity Checks for CLI/UI changes' with explicit commands, including npm run check:docs:settings.
• package.json
  • Added a new npm script check:docs:settings which executes predocs:settings and docs:settings -- --check.
  • Modified the preflight npm script to include npm run check:docs:settings in its sequence of commands.

Activity

• No human activity has occurred on this pull request yet.

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]

Code Review

This pull request introduces a new check:docs:settings script to verify that settings documentation is up-to-date and integrates it into the preflight CI check. This is a great improvement for catching documentation parity issues early. The documentation in GEMINI.md is also updated accordingly. My review includes one high-severity suggestion in package.json to fix a redundant build step in the new script, which will improve its efficiency.

[gemini-code-assist]

The check:docs:settings script redundantly runs predocs:settings. The docs:settings script already has a predocs:settings lifecycle hook defined, which npm automatically executes before running docs:settings. This causes the build for @google/gemini-cli-core to run twice, making the check inefficient.

You can simplify the script to rely on the implicit execution of the pre hook.

Suggested change

	"check:docs:settings": "npm run predocs:settings && npm run docs:settings -- --check",
	"check:docs:settings": "npm run docs:settings -- --check",

[github-actions]

Size Change: -2 B (0%)

Total Size: 24.4 MB

ℹ️ View Unchanged

Filename	Size	Change
./bundle/gemini.js	24.4 MB	-2 B (0%)
./bundle/sandbox-macos-permissive-open.sb	890 B	0 B
./bundle/sandbox-macos-permissive-proxied.sb	1.31 kB	0 B
./bundle/sandbox-macos-restrictive-open.sb	3.36 kB	0 B
./bundle/sandbox-macos-restrictive-proxied.sb	3.56 kB	0 B
./bundle/sandbox-macos-strict-open.sb	4.82 kB	0 B
./bundle/sandbox-macos-strict-proxied.sb	5.02 kB	0 B

_{compressed-size-action}

[LyalinDotCom]

Suggestion from Sahoon

we can also do a check with keybindings doc check? which I think is npm run docs:keybindings -- --check