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

Prepare for v3.0.0 #123

Merged
merged 1 commit into from
Oct 5, 2024
Merged

Prepare for v3.0.0 #123

merged 1 commit into from
Oct 5, 2024

Conversation

jodastephen
Copy link
Member

@jodastephen jodastephen commented Oct 5, 2024

Summary by CodeRabbit

  • New Features

    • Updated security documentation to clarify which versions will receive patches.
    • Introduced new release version 3.0.0 and added 2.2.4 in the release notes, reflecting improved dependency management.
  • Bug Fixes

    • Minor textual enhancements and version updates in documentation for clarity.
  • Chores

    • Script updated to include commands for deleting remote branches to streamline repository management.

Copy link

coderabbitai bot commented Oct 5, 2024

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The changes encompass updates to several files, primarily focusing on version information and security patch clarifications. The SECURITY.md file now specifies that only the latest versions of v3.x and v2.x will receive security patches. The website.sh script has been modified to include commands for deleting specific remote branches. The changes.xml file reflects a version update from 3.0.0-RC1 to 3.0.0, with additional details on dependency management and new release entries. Lastly, index.md has updated version numbers for the Joda-Convert library.

Changes

File Change Summary
.github/SECURITY.md Updated "Supported Versions" section to specify that only the latest versions of v3.x and v2.x are guaranteed to be patched.
.github/website.sh Added commands to delete remote branches website and website2x, ensuring the script continues even if the delete commands fail.
src/changes/changes.xml Updated release version from 3.0.0-RC1 to 3.0.0 with a new release date of 2024-10-04, added new release entry for 2.2.4, and updated dependency management methods.
src/site/markdown/index.md Updated version numbers for Joda-Convert library to 3.0.0 for the 3.x branch and 2.2.4 for the 2.x branch, with minor textual enhancements.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Git
    participant Script

    User->>Script: Run website.sh
    Script->>Git: Push main branch
    Script->>Git: Delete remote branch website
    Script->>Git: Delete remote branch website2x
    Script->>User: Complete execution
Loading

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.

@jodastephen jodastephen merged commit c51eda3 into main Oct 5, 2024
3 of 4 checks passed
@jodastephen jodastephen deleted the prepare-release branch October 5, 2024 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant