Skip to content

ci: add coderabbit config yaml#197

Merged
froggy1014 merged 2 commits intorelease/v1from
ci/add-coderabbit-config
Aug 22, 2025
Merged

ci: add coderabbit config yaml#197
froggy1014 merged 2 commits intorelease/v1from
ci/add-coderabbit-config

Conversation

@froggy1014
Copy link
Copy Markdown
Contributor

@froggy1014 froggy1014 commented Aug 16, 2025

Changes

현재 코드래빗 default branch 외에는 skip 되도록 설정이 되어있더라구요.

그래서 그 설정 변경할겸, 저희 프로젝트에 맞게 프롬프트 추가해봤습니다 ~

Visuals

Checklist

  • Have you written the functional specifications?
  • Have you written the test code?

Additional Discussion Points

Summary by CodeRabbit

  • Chores
    • Added a repository-wide configuration to automate PR reviews and chat replies.
    • Centralized review guidance for components, styles, tests, stories, design tokens, docs, and build/config files.
    • Implemented path-based filters to ignore non-source artifacts during automated reviews.
    • Enabled incremental auto-review on main and release branches; no user-facing changes.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Aug 16, 2025

⚠️ No Changeset found

Latest commit: 02242b3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

💥 An error occurred when fetching the changed packages and changesets in this PR
Some errors occurred when validating the changesets config:
The package or glob expression "@sipe-team/package-name" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.

@netlify
Copy link
Copy Markdown

netlify bot commented Aug 16, 2025

Deploy Preview for side-design-system ready!

Name Link
🔨 Latest commit 02242b3
🔍 Latest deploy log https://app.netlify.com/projects/side-design-system/deploys/68a02a6e54b1150008390ca4
😎 Deploy Preview https://deploy-preview-197--side-design-system.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Aug 16, 2025

Walkthrough

Adds a new .coderabbit.yaml configuration defining global review settings, file/path filters, detailed path-specific review instructions (React, vanilla-extract CSS, tests, Storybook, tokens, package/ts/tsup/biome, README), auto-review rules for branches with incremental mode, and chat auto-reply.

Changes

Cohort / File(s) Summary
CodeRabbit configuration
./.coderabbit.yaml
Adds centralized CodeRabbit config: global options (language, profile, toggles), path_filters excluding non-source artifacts, extensive path_instructions for React components, vanilla-extract CSS, tests, Storybook stories, design tokens, package.json, tsconfig, tsup config, biome.json, README guidance; enables auto_review (branches: main, release/v1) with incremental_review and ignored title patterns; chat auto_reply enabled.

Sequence Diagram(s)

sequenceDiagram
  participant Dev as Developer
  participant Repo as Repository
  participant CR as CodeRabbit
  participant PR as Pull Request

  Dev->>Repo: Open or update PR
  Repo-->>CR: Notify (auto_review enabled)
  CR->>CR: Apply path_filters to changed files
  CR->>CR: Load matching path_instructions
  CR-->>PR: Post review summary, status, and suggestions
  CR-->>Dev: Send auto-reply in chat (if configured)
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch ci/add-coderabbit-config

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
🪧 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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@codecov
Copy link
Copy Markdown

codecov bot commented Aug 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@froggy1014
Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Aug 16, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 7

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between e21fa3c and 7b20913.

📒 Files selected for processing (1)
  • .coderabbit.yaml (1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
.coderabbit.yaml

[error] 30-30: trailing spaces

(trailing-spaces)


[error] 43-43: trailing spaces

(trailing-spaces)


[error] 56-56: trailing spaces

(trailing-spaces)


[error] 68-68: trailing spaces

(trailing-spaces)


[error] 78-78: trailing spaces

(trailing-spaces)


[error] 87-87: trailing spaces

(trailing-spaces)


[error] 96-96: trailing spaces

(trailing-spaces)


[error] 105-105: trailing spaces

(trailing-spaces)


[error] 114-114: trailing spaces

(trailing-spaces)


[error] 141-141: no new line character at the end of file

(new-line-at-end-of-file)

🔇 Additional comments (1)
.coderabbit.yaml (1)

135-138: Ignore suggested change to base_branches
There’s no “default-branch-only” setting or author note in this file—your configuration intentionally limits auto-reviews to PRs targeting main and release/v1, which matches what’s in .coderabbit.yaml. If your goal really is to run reviews on every branch, you can replace the list with ['.*']; otherwise, no update is needed here.

Likely an incorrect or invalid review comment.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

♻️ Duplicate comments (5)
.coderabbit.yaml (5)

9-16: Path filters are sensible. Consider excluding coverage and framework output dirs if present.

If your repo has these dirs, exclude them to reduce noise and clone size.

Apply this diff:

   path_filters:
     - "!.templates/**"
     - "!.changeset/**"
     - "!**/pnpm-lock.yaml"
     - "!**/node_modules/**"
     - "!**/dist/**"
     - "!**/storybook-static/**"
     - "!**/*.d.ts"
+    - "!**/coverage/**"
+    - "!**/.next/**"
+    - "!**/.output/**"

19-20: Glob patterns are too shallow under src; use recursive globs and add common variants.

Using .ext will miss files in nested folders. Widen to **/.ext and consider common test/story variants.

Apply this diff:

-    - path: "**/packages/*/src/*.tsx"
+    - path: "**/packages/*/src/**/*.tsx"
@@
-    - path: "**/packages/*/src/*.css.ts"
+    - path: "**/packages/*/src/**/*.css.ts"
@@
-    - path: "**/packages/*/src/*.test.tsx"
+    - path: "**/packages/*/src/**/*.test.tsx"
+    - path: "**/packages/*/src/**/*.test.ts"
+    - path: "**/packages/*/src/**/*.spec.tsx"
+    - path: "**/packages/*/src/**/*.spec.ts"
@@
-    - path: "**/packages/*/src/*.stories.tsx"
+    - path: "**/packages/*/src/**/*.stories.tsx"
+    - path: "**/packages/*/src/**/*.stories.mdx"

Also applies to: 32-33, 45-46, 58-59


45-56: Enhance test guidance with automated a11y checks and keyboard navigation

Add explicit requirements for a11y assertions and keyboard operability.

Apply this diff:

       instructions: |
         Review test files for:
         - English test descriptions (convert Korean descriptions to English)
         - Comprehensive test coverage including visual, behavioral, and accessibility tests
+        - Automated accessibility assertions (e.g., jest-axe or @axe-core/react)
+        - Keyboard navigation (Tab/Shift+Tab focus order, Enter/Space activation) for interactive components
         - Theme compatibility testing - ensure components work with different theme variants
         - Proper use of @testing-library/react patterns
         - Testing component variants, props, and edge cases
         - ThemeProvider wrapper in tests when testing theme-dependent components
         - Consistent test structure and naming conventions
         - Proper setup and cleanup in test files

69-78: Protect downstreams: add “no breaking token rename without codemod” policy and deprecation flow

Codify migration expectations for token changes.

Apply this diff:

       instructions: |
         Review design token changes for:
         - Backward compatibility with existing components
         - Consistent naming conventions following established patterns
         - Proper TypeScript exports and type definitions
         - Impact on overall design system consistency
         - Documentation of token usage and purpose
+        - No breaking token renames unless a codemod/migration (or clear mapping) is provided
+        - Enforce a deprecation period with a documented replacement token before removal/rename

30-30: Trim trailing whitespace on blank lines

YAML linters flag these as trailing-spaces. Remove the spaces (keep the blank lines).

You can auto-fix with:

  • npx prettier .coderabbit.yaml --write
  • or run yamllint to locate/fix.

Also applies to: 43-43, 56-56, 68-68, 78-78, 87-87, 96-96, 105-105, 114-114

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 7b20913 and 02242b3.

📒 Files selected for processing (1)
  • .coderabbit.yaml (1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
.coderabbit.yaml

[error] 30-30: trailing spaces

(trailing-spaces)


[error] 43-43: trailing spaces

(trailing-spaces)


[error] 56-56: trailing spaces

(trailing-spaces)


[error] 68-68: trailing spaces

(trailing-spaces)


[error] 78-78: trailing spaces

(trailing-spaces)


[error] 87-87: trailing spaces

(trailing-spaces)


[error] 96-96: trailing spaces

(trailing-spaces)


[error] 105-105: trailing spaces

(trailing-spaces)


[error] 114-114: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: coverage
🔇 Additional comments (4)
.coderabbit.yaml (4)

1-8: Solid global settings block

Top-level keys and review toggles are well-formed and align with the schema.


124-138: Auto-review block is correctly nested and uses the right key

Good fix: auto_review is under reviews and uses auto_incremental_review.


124-138: Minor mismatch with AI summary: key name differs

The AI summary mentions incremental_review, but the config correctly uses auto_incremental_review per schema. No action needed.


139-141: Chat auto-reply enabled

Looks good. Keep an eye on noise levels in busy repos.

@froggy1014 froggy1014 merged commit fb6d0b2 into release/v1 Aug 22, 2025
8 checks passed
@froggy1014 froggy1014 deleted the ci/add-coderabbit-config branch August 22, 2025 00:45
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.

1 participant