Skip to content

chore: community edition product updates link#6132

Merged
sriramveeraghanta merged 3 commits intopreviewfrom
chore-product-update
Dec 3, 2024
Merged

chore: community edition product updates link#6132
sriramveeraghanta merged 3 commits intopreviewfrom
chore-product-update

Conversation

@prateekshourya29
Copy link
Member

@prateekshourya29 prateekshourya29 commented Dec 2, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a modal for product updates that can display changelog information directly.
    • Added an optional URL property in instance configurations for easier access to changelog details.
  • Improvements

    • Enhanced the logo component to better handle font loading, ensuring visual consistency.
    • Updated the button for opening the product updates modal to improve user interaction without page navigation.
  • Bug Fixes

    • Removed unnecessary loading and error handling in the product updates modal for a more streamlined experience.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 2, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several modifications across multiple components. The SidebarHelpSection component now manages the visibility of the ProductUpdatesModal using a new state variable. The Logo component has been enhanced to monitor font loading states and streamline imports. The ProductUpdatesModal has been refactored to simplify its logic, focusing on the availability of a changelog URL. Additionally, a new optional property for instance configuration has been added to facilitate referencing changelog information.

Changes

File Path Change Summary
web/core/components/workspace/sidebar/help-section.tsx Updated state management for ProductUpdatesModal, changing state variable and button element.
packages/types/src/instance/base.d.ts Added optional property instance_changelog_url to IInstanceConfig interface.
web/core/components/common/logo.tsx Integrated useFontFaceObserver for font loading, reorganized imports, and maintained emoji rendering logic.
web/core/components/global/product-updates/modal.tsx Removed unnecessary imports and refactored logic to focus on instance_changelog_url.

Possibly related PRs

Suggested labels

🌐frontend, 🧹chore, pages

Suggested reviewers

  • SatishGandham
  • rahulramesha

Poem

In the sidebar where updates gleam,
A button now opens a brand new dream.
With fonts that dance and emojis that play,
Changelog links brighten the day.
Hopping along, we celebrate this feat,
In our code garden, all changes are sweet! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7ed35e5 and 753f0fd.

📒 Files selected for processing (4)
  • packages/types/src/instance/base.d.ts (1 hunks)
  • web/core/components/common/logo.tsx (1 hunks)
  • web/core/components/global/product-updates/modal.tsx (2 hunks)
  • web/core/components/workspace/sidebar/help-section.tsx (5 hunks)

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

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 and nitpick comments (2)
web/ce/helpers/dashboard.helper.ts (1)

7-7: Consider moving the URL to a configuration file

The hardcoded URL would be better placed in a configuration file or environment variable for easier maintenance and environment-specific configurations.

web/core/components/workspace/sidebar/help-section.tsx (1)

38-39: Consider moving the derived value closer to usage

The productUpdatesLink is only used in the "What's new" menu item. Consider moving this closer to where it's used to improve code readability and maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3c6006d and 7ed35e5.

📒 Files selected for processing (2)
  • web/ce/helpers/dashboard.helper.ts (1 hunks)
  • web/core/components/workspace/sidebar/help-section.tsx (3 hunks)
🔇 Additional comments (3)
web/ce/helpers/dashboard.helper.ts (1)

6-7: Implementation looks good!

The function is simple, focused, and serves its purpose well.

web/core/components/workspace/sidebar/help-section.tsx (2)

19-20: Import organization looks good!

The new import is properly placed in the plane web helpers section.


145-145: Implementation looks good!

The URL replacement is clean and properly uses the new helper function.

@sriramveeraghanta sriramveeraghanta merged commit 849d989 into preview Dec 3, 2024
@sriramveeraghanta sriramveeraghanta deleted the chore-product-update branch December 3, 2024 07:58
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.

3 participants