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

Update CHANGELOG.md for v0.1.7 #324

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Update CHANGELOG.md for v0.1.7 #324

merged 1 commit into from
Aug 29, 2024

Conversation

devleejb
Copy link
Member

@devleejb devleejb commented Aug 29, 2024

What this PR does / why we need it:

Update CHANGELOG.md for v0.1.7

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:


Additional documentation:


Checklist:

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features

    • Introduced scroll navigation functionality to enhance user experience from the profile view.
    • Implemented security enhancements to the preview feature to address XSS vulnerabilities.
  • Version Updates

    • Updated the version of both backend and frontend components to 0.1.7, reflecting new features and improvements.

Copy link
Contributor

coderabbitai bot commented Aug 29, 2024

Walkthrough

The updates include a new version release for both the backend and frontend components of the project, incrementing the version number from 0.1.6 to 0.1.7. The changes introduce scroll navigation functionality to the user's location from the profile view and enhance security by implementing rehypeSanitize to mitigate XSS vulnerabilities in the preview feature.

Changes

Files Change Summary
backend/package.json, frontend/package.json Version updated from 0.1.6 to 0.1.7 in both package files.
CHANGELOG.md Added new section for version 0.1.7 detailing the addition of scroll navigation and rehypeSanitize.

Poem

🐰 In the garden where we play,
New features bloom, hip-hip-hooray!
Scroll to find your spot with glee,
Safe and sound, just hop with me!
With every change, we leap and bound,
A joyful dance on new-found ground! 🌼


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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, codebase verification and nitpick comments (1)
CHANGELOG.md (1)

14-14: Format bare URLs for better readability.

Markdownlint flags bare URLs. Format the URLs for better readability:

- Add scroll navigation to user's location from profile view by @choidabom in https://github.com/yorkie-team/codepair/pull/316
+ Add scroll navigation to user's location from profile view by @choidabom in [#316](https://github.com/yorkie-team/codepair/pull/316)

- Added rehypeSanitize to improve preview xss issues by @taeng0204 in https://github.com/yorkie-team/codepair/pull/323
+ Added rehypeSanitize to improve preview xss issues by @taeng0204 in [#323](https://github.com/yorkie-team/codepair/pull/323)

Also applies to: 18-18

Tools
Markdownlint

14-14: null
Bare URL used

(MD034, no-bare-urls)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 09fd1f8 and f9cc39d.

Files ignored due to path filters (2)
  • backend/package-lock.json is excluded by !**/package-lock.json
  • frontend/package-lock.json is excluded by !**/package-lock.json
Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • backend/package.json (1 hunks)
  • frontend/package.json (1 hunks)
Files skipped from review due to trivial changes (2)
  • backend/package.json
  • frontend/package.json
Additional context used
Markdownlint
CHANGELOG.md

14-14: null
Bare URL used

(MD034, no-bare-urls)


18-18: null
Bare URL used

(MD034, no-bare-urls)

Additional comments not posted (2)
CHANGELOG.md (2)

10-18: LGTM!

The new version entry for 0.1.7 is well-documented and follows the format used in previous entries.

Tools
Markdownlint

14-14: null
Bare URL used

(MD034, no-bare-urls)


18-18: null
Bare URL used

(MD034, no-bare-urls)


Line range hint 1-254: Overall structure and consistency are well-maintained.

The CHANGELOG.md file follows the Keep a Changelog format, and the entries are consistent and well-organized.

Tools
Markdownlint

14-14: null
Bare URL used

(MD034, no-bare-urls)


18-18: null
Bare URL used

(MD034, no-bare-urls)

@devleejb devleejb merged commit 75df2ae into main Aug 29, 2024
3 checks passed
@devleejb devleejb deleted the v0.1.7 branch August 29, 2024 14:41
@coderabbitai coderabbitai bot mentioned this pull request Sep 12, 2024
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request Sep 28, 2024
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request Oct 14, 2024
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request Oct 25, 2024
2 tasks
minai621 pushed a commit that referenced this pull request Nov 5, 2024
@coderabbitai coderabbitai bot mentioned this pull request Nov 5, 2024
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request Nov 20, 2024
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request Nov 30, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant