feat: issue version history
Summary by CodeRabbit
Release Notes
-
New Features
- Introduced
IssueVersionHistorycomponent for enhanced version tracking in issue details. - Added
IssueVersionEditorcomponent for managing version edits. - Implemented
EditorVersionHistoryOverlayfor displaying version history in the editor.
- Introduced
-
Improvements
- Updated version management to utilize
TEditorVersionfor consistency across components. - Enhanced UI with new version history overlays and editors.
- Updated version management to utilize
-
Bug Fixes
- Resolved inconsistencies in version fetching methods and parameters.
-
Documentation
- Updated export statements to reflect new module structures and components.
[!IMPORTANT]
Review skipped
Draft detected.
Please check the settings in the CodeRabbit UI or the
.coderabbit.yamlfile in this repository. To trigger a single review, invoke the@coderabbitai reviewcommand.You can disable this status message by setting the
reviews.review_statustofalsein the CodeRabbit configuration file.
Walkthrough
The changes in this pull request primarily involve renaming and restructuring type definitions related to version management in the editor components. The type TPageVersion has been renamed to TEditorVersion, and various components have been updated to reflect this change. Additionally, new components and services have been introduced to enhance version history functionality, while existing components have been modified to align with the new type definitions and overall structure.
Changes
| File | Change Summary |
|---|---|
packages/types/src/pages.d.ts |
Renamed type TPageVersion to TEditorVersion, removed page property. |
web/core/components/editor/index.ts |
Added export statement for version-history. |
web/core/components/editor/version-history/editors/index.ts |
Introduced new type TVersionEditorProps, exported entities from issue-version-editor and page-version-editor. |
web/core/components/editor/version-history/editors/issue-version-editor.tsx |
Added IssueVersionEditor component, handles version states and renders a read-only editor. |
web/core/components/editor/version-history/editors/page-version-editor.tsx |
Renamed component from PagesVersionEditor to PageVersionEditor, removed unused imports and TVersionEditorProps. |
web/core/components/editor/version-history/index.ts |
Changed export from ./editor to ./editors. |
web/core/components/editor/version-history/main-content.tsx |
Renamed component from PageVersionsMainContent to EditorVersionHistoryMainContent, updated method signatures. |
web/core/components/editor/version-history/root.tsx |
Renamed component from PageVersionsOverlay to EditorVersionHistoryOverlay, updated method signatures. |
web/core/components/editor/version-history/sidebar-list-item.tsx |
Updated version prop type from TPageVersion to TEditorVersion, renamed component. |
web/core/components/editor/version-history/sidebar-list.tsx |
Renamed component from PageVersionsSidebarList to EditorVersionHistorySidebarList, updated method signatures. |
web/core/components/editor/version-history/sidebar-root.tsx |
Renamed component from PageVersionsSidebarRoot to EditorVersionHistorySidebarRoot, updated method signatures. |
web/core/components/issues/issue-detail/index.ts |
Removed export of issue-detail-quick-actions, added version-history to exports. |
web/core/components/issues/issue-detail/root.tsx |
Added IssueVersionHistory component to render output. |
web/core/components/issues/issue-detail/version-history.tsx |
Introduced IssueVersionHistory component for managing version history display. |
web/core/components/pages/editor/page-root.tsx |
Replaced PageVersionsOverlay with EditorVersionHistoryOverlay, updated props. |
web/core/services/issue/index.ts |
Added export for issue_version.service. |
web/core/services/issue/issue_version.service.ts |
Introduced IssueVersionService class with methods for fetching version data. |
web/core/services/page/project-page-version.service.ts |
Updated return types of methods to TEditorVersion. |
Possibly related PRs
-
#5417: Introduces a new type definition
TPageVersion, related to the renaming ofTPageVersiontoTEditorVersion. -
#5703: Addresses rendering of the current version's description, relevant to changes in the
TEditorVersiontype. - #5830: Involves a common modal for creating and updating issues, potentially related to version handling.
- #5901: Introduces upload progress for attachments, indirectly related to version management changes.
- #5910: Focuses on updates to the core editor for mobile functionality, linking back to editor behavior changes.
Suggested labels
✨feature, 🌐frontend, 🛠️refactor
Suggested reviewers
- SatishGandham
- rahulramesha
🐇 In the editor's den, where changes bloom,
A new version's tale dispels the gloom.
From pages to editors, we shift our view,
With props and types, our work is anew!
Hop along, dear code, let’s make it bright,
For every version holds a story in sight! 🌟
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?
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.