Add exclude.readOnly and exclude.hidden to gerrit connection config

[brendan-kellam]

^ Title ^

Summary by CodeRabbit

• New Features
  • Added options to exclude read-only and hidden projects from Gerrit syncing via configuration settings.
• Bug Fixes
  • Improved filtering logic to more accurately exclude special, read-only, and hidden projects based on configuration.
• Documentation
  • Updated configuration schema documentation to describe new exclusion options for read-only and hidden projects.

[coderabbitai]

Walkthrough

This update introduces enhancements to the Gerrit connection configuration by adding new options to exclude read-only and hidden projects from synchronization. The backend logic is updated to support these options by introducing a type for project states and a helper function to centralize exclusion logic. The schema and type definitions for Gerrit connection configuration are extended across multiple files to include the new readOnly and hidden exclusion flags, both defaulting to false. The code now filters projects based on these new configuration options in addition to existing exclusion patterns.

Changes

File(s)	Change Summary
packages/backend/src/gerrit.ts	Updated to use GerritConnectionConfig (v3), introduced GerritProjectState type, added shouldExcludeProject helper, and centralized exclusion logic for filtering projects based on new config flags and patterns.
packages/schemas/src/v3/connection.schema.ts packages/schemas/src/v3/gerrit.schema.ts packages/schemas/src/v3/index.schema.ts schemas/v3/gerrit.json	Extended the Gerrit connection config schema to add readOnly and hidden boolean properties under the exclude object, both defaulting to false.
packages/schemas/src/v3/connection.type.ts packages/schemas/src/v3/gerrit.type.ts packages/schemas/src/v3/index.type.ts	Updated the GerritConnectionConfig interface to include optional readOnly? and hidden? boolean properties in the exclude object.
CHANGELOG.md	Added changelog entry documenting the new exclude.readOnly and exclude.hidden configuration options for Gerrit.
docs/docs/connections/gerrit.mdx	Updated documentation to include new readOnly and hidden exclusion flags with descriptions and example configuration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Backend
    participant Gerrit

    User->>Backend: Request Gerrit repos (with config)
    Backend->>Gerrit: Fetch all projects
    Gerrit-->>Backend: Return list of projects
    Backend->>Backend: For each project, call shouldExcludeProject
    alt Project is excluded (special, read-only, hidden, or matches glob)
        Backend->>Backend: Exclude project, log reason
    else Project is included
        Backend->>Backend: Add project to result
    end
    Backend-->>User: Return filtered project list

Loading

Poem

In the warren of code, a new path we find,
Excluding the hidden, the read-only behind.
With schemas extended and types now precise,
The project list filtered—oh, isn’t that nice?
🐇✨ Now only the active ones hop into view,
Gerrit’s garden is cleaner, and easier to chew!

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/docs/connections/gerrit.mdx (2)

54-61: Clarify example JSON validity
The snippet uses // comments inside a JSON block, which isn’t valid JSON. Consider one of the following to avoid confusion:

1. Remove the comments or move them into accompanying prose.
2. Add a note that this is “pseudo-JSON” for illustration only.
   Also double-check that the trailing comma after the projects array is rendered correctly in your MDX context.

---

119-129: Well-defined schema—consider adding examples
The new readOnly and hidden boolean properties (with default: false) are correctly added to the JSON schema. For better discoverability, you might:

• Add an examples array for each new property under exclude.
• Update the surrounding prose to call out the defaults when these flags are omitted.
  This will help users understand how to enable these flags in practice.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2f81306 and b136c48.

📒 Files selected for processing (1)

• docs/docs/connections/gerrit.mdx (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build