Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: enable cyclic deps check for UI packages #38658

Open
wants to merge 6 commits into
base: release
Choose a base branch
from

Conversation

dvj1988
Copy link
Contributor

@dvj1988 dvj1988 commented Jan 15, 2025

Description

Tip

Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).

Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags=""

🔍 Cypress test results

Warning

Tests have not run on the HEAD f2a517d yet


Wed, 15 Jan 2025 07:56:57 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • Chores
    • Updated GitHub workflow configuration to monitor additional client package directories for cyclic dependency checks
    • Added a comment to an Avatar constants file

@dvj1988 dvj1988 requested a review from sharat87 as a code owner January 15, 2025 06:14
Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request introduces an expanded scope for cyclic dependency checks in the GitHub workflow configuration. New directories within the app/client path have been added to the monitoring list, including packages for AST, design system, DSL, icons, and utilities. Additionally, a minor comment was added to the Avatar.constants.ts file, which does not impact the code's functionality.

Changes

File Change Summary
.github/workflows/ci-client-cyclic-deps-check.yml Added monitoring for additional client package directories: app/client/packages/ast/**, app/client/packages/design-system/**, app/client/packages/dsl/**, app/client/packages/icons/**, and app/client/packages/utils/**
app/client/packages/design-system/ads/src/Avatar/Avatar.constants.ts Added a single comment line with no functional changes

Possibly related PRs

Suggested labels

ok-to-test, Git Product

Suggested reviewers

  • sharat87
  • ApekshaBhosale
  • sagar-qa007

Poem

Cyclic paths, now wider tracked,
Dependencies dance, no longer stacked
A workflow's embrace, more packages in sight
Checking connections, keeping code tight! 🕸️🔍


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e0543ac and f2a517d.

📒 Files selected for processing (1)
  • app/client/packages/design-system/ads/src/Avatar/Avatar.constants.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • app/client/packages/design-system/ads/src/Avatar/Avatar.constants.ts
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: client-unit-tests / client-unit-tests
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies
  • GitHub Check: client-build / client-build
  • GitHub Check: client-prettier / prettier-check
  • GitHub Check: chromatic-deployment
  • GitHub Check: chromatic-deployment
  • GitHub Check: storybook-tests

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • 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. (Beta)
  • @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.

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.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Jan 15, 2025
Copy link
Contributor

@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: 0

🔭 Outside diff range comments (1)
.github/workflows/ci-client-cyclic-deps-check.yml (1)

Update dpdm commands to include package dependencies

-npx dpdm ./src/* --circular --warning=false --tree=false
+npx dpdm "./src/*" "./packages/**/src/*" --circular --warning=false --tree=false
  • Update both dpdm commands in the workflow (PR branch and release branch steps)
  • This change ensures cyclic dependency detection across all monitored directories
🔗 Analysis chain

Line range hint 1-89: Verify the dpdm command configuration.

The dpdm command only checks files in ./src/* but should also check the newly added package directories.

Run this script to verify the dpdm configuration:

After verification, update the dpdm command to include package directories:

-npx dpdm ./src/* --circular --warning=false --tree=false
+npx dpdm "./src/*" "./packages/**/src/*" --circular --warning=false --tree=false
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if dpdm command includes all monitored directories

# Get the dpdm command
cmd=$(rg "npx dpdm" -A 1)
echo "Current dpdm command:"
echo "$cmd"

# List all monitored directories
echo -e "\nMonitored directories from changed-files action:"
rg "files: \|" -A 10

Length of output: 228


Script:

#!/bin/bash
# Check workflow file content and package structure
echo "=== Workflow File Content ==="
cat .github/workflows/ci-client-cyclic-deps-check.yml

echo -e "\n=== Package Directory Structure ==="
fd . "app/client/packages" -t d -d 2

echo -e "\n=== Checking for src directories in packages ==="
fd "src" "app/client/packages" -t d

Length of output: 8420

🧹 Nitpick comments (1)
.github/workflows/ci-client-cyclic-deps-check.yml (1)

36-40: Consider adding package.json files to the watch list.

While monitoring the source files is good, changes to dependencies in package.json files could also introduce cyclic dependencies.

Add this to the files list:

 app/client/packages/ast/**
 app/client/packages/design-system/**
 app/client/packages/dsl/**
 app/client/packages/icons/**
 app/client/packages/utils/**
+app/client/packages/*/package.json
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a23bcbf and c22b04a.

📒 Files selected for processing (2)
  • .github/workflows/ci-client-cyclic-deps-check.yml (1 hunks)
  • app/client/src/index.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • app/client/src/index.tsx
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: client-lint / client-lint
  • GitHub Check: client-check-cyclic-deps / check-cyclic-dependencies
  • GitHub Check: client-build / client-build
  • GitHub Check: client-prettier / prettier-check
  • GitHub Check: client-unit-tests / client-unit-tests
🔇 Additional comments (1)
.github/workflows/ci-client-cyclic-deps-check.yml (1)

36-40: LGTM! Good addition of package directories.

The inclusion of these package directories will help catch cyclic dependencies across the UI component library ecosystem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant