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.13 #358

Merged
merged 1 commit into from
Sep 23, 2024
Merged

Update CHANGELOG.md for v0.1.13 #358

merged 1 commit into from
Sep 23, 2024

Conversation

devleejb
Copy link
Member

@devleejb devleejb commented Sep 23, 2024

What this PR does / why we need it:

  • Update CHANGELOG.md for v0.1.13

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

    • Users can now modify document titles.
    • Updated design for the document title feature.
  • Bug Fixes

    • Resolved abnormal line spacing in Markdown lists.
    • Fixed a race condition in the Axios Interceptor for Refresh Token.
  • Chores

    • Version updated for both backend and frontend packages to 0.1.13.

@devleejb devleejb self-assigned this Sep 23, 2024
Copy link
Contributor

coderabbitai bot commented Sep 23, 2024

Walkthrough

The pull request introduces version 0.1.13 for both the backend and frontend packages, reflecting updates made on September 23, 2024. It includes new features such as the ability to modify document titles and design changes related to this feature. Additionally, two significant fixes are implemented: one for abnormal line spacing in Markdown lists and another addressing a race condition in the Axios Interceptor for Refresh Token. The changelog has been updated accordingly to document these changes.

Changes

Files Change Summary
CHANGELOG.md Updated to include version 0.1.13, detailing new features and fixes.
backend/package.json Version updated from 0.1.12 to 0.1.13. No other changes made.
frontend/package.json Version updated from 0.1.12 to 0.1.13. No other changes made.

Possibly related PRs

Poem

🐇 In the garden of code, we hop and play,
With titles anew, brightening the day.
Fixes abound, like carrots in rows,
Changelog updated, as everyone knows.
Hooray for the changes, let’s leap with delight,
For version 0.1.13 shines ever so bright! 🌟


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.

@devleejb devleejb merged commit b0d80a3 into main Sep 23, 2024
3 checks passed
@devleejb devleejb deleted the v0.1.13 branch September 23, 2024 13:36
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)
CHANGELOG.md (2)

10-20: LGTM! Consider adding an empty "Unreleased" section.

The new entry for version 0.1.13 is well-structured and informative. It follows the Keep a Changelog format, clearly separating additions and fixes. The inclusion of GitHub usernames and pull request links is helpful for tracking changes.

For consistency with the Keep a Changelog format, consider adding an empty "Unreleased" section above the latest release. This allows for tracking upcoming changes before the next release.

Add an empty "Unreleased" section like this:

 ## [Unreleased]
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
 ## [0.1.13] - 2024-09-23
Tools
Markdownlint

14-14: null
Bare URL used

(MD034, no-bare-urls)


15-15: null
Bare URL used

(MD034, no-bare-urls)


19-19: null
Bare URL used

(MD034, no-bare-urls)


20-20: null
Bare URL used

(MD034, no-bare-urls)


14-15: Improve markdown formatting for URLs

To resolve the Markdownlint warnings and improve the markdown formatting, consider wrapping the GitHub pull request URLs in angle brackets.

Apply this change to all pull request links in the changelog:

-https://github.com/yorkie-team/codepair/pull/342
+<https://github.com/yorkie-team/codepair/pull/342>

Also applies to: 19-20

Tools
Markdownlint

14-14: null
Bare URL used

(MD034, no-bare-urls)


15-15: 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 ead93c7 and 33ad816.

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)


15-15: null
Bare URL used

(MD034, no-bare-urls)


19-19: null
Bare URL used

(MD034, no-bare-urls)


20-20: null
Bare URL used

(MD034, no-bare-urls)

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

Line range hint 1-21: LGTM! Changelog structure and consistency are excellent.

The changelog maintains a consistent and clear format throughout. The use of categories (Added, Changed, Fixed, etc.) within each version helps users quickly identify the nature of each change. The concise descriptions provide sufficient information without being overly verbose.

Keep up the good work in maintaining this changelog. It serves as an excellent record of the project's evolution.

Tools
Markdownlint

14-14: null
Bare URL used

(MD034, no-bare-urls)


15-15: null
Bare URL used

(MD034, no-bare-urls)


19-19: null
Bare URL used

(MD034, no-bare-urls)


20-20: null
Bare URL used

(MD034, no-bare-urls)

This was referenced Sep 28, 2024
@coderabbitai coderabbitai bot mentioned this pull request Oct 14, 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
None yet
Development

Successfully merging this pull request may close these issues.

1 participant