docs: add v5.1.0 to changelog

[sainoe]

Description

Add a v5.1.0 .changelog entry and update CHANGELOG.md.

Closes: #XXXX

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct docs: prefix in the PR title
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

• Confirmed the correct docs: prefix in the PR title
• Confirmed all author checklist items have been addressed
• Confirmed that this PR only changes documentation
• Reviewed content for consistency
• Reviewed content for spelling and grammar
• Tested instructions (if applicable)
• Checked that the documentation website can be built and deployed successfully (run make build-docs)

Summary by CodeRabbit

• New Features

  • Removal of the "soft opt-out" feature, streamlining user interaction and enhancing compliance with security protocols.

• User Experience Improvements

  • Stricter error handling for key assignment in the Provider module, enforcing enhanced key management integrity.

• Changelog Updates

  • Introduction of the changelog for version 5.1.0, providing transparency and a structured record of changes.

[coderabbitai]

Walkthrough

Walkthrough

Version 5.1.0 introduces the removal of the "soft opt-out" feature, signifying a move towards enhanced security and streamlined user experience. This API-breaking change is backed by previous modifications and aims to simplify code management. Additionally, the key assignment logic in the Provider module is updated to enforce stricter error handling for key reuse, further improving system integrity.

Changes

Files	Change Summary
.changelog/v5.1.0/api-breaking/1995-deprecate-soft-opt-out.md, .changelog/v5.1.0/features/1995-deprecate-soft-opt-out.md, .changelog/v5.1.0/state-breaking/1995-deprecate-soft-opt-out.md	Removal of the "soft opt-out" feature, indicating a shift towards stricter security measures.
.changelog/v5.1.0/summary.md	New entry added to document version 5.1.0 and maintain changelog transparency.
CHANGELOG.md	Major changes documented, including the soft opt-out removal and stricter key assignment handling in the Provider module.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System
    participant Provider

    User->>System: Request key assignment
    System->>Provider: Validate key
    Provider-->>System: Key is valid
    System-->>User: Key assigned

    User->>System: Attempt to reuse key
    System->>Provider: Validate key
    Provider-->>System: Key reuse error
    System-->>User: Error: Key already in use

Loading

This diagram illustrates the interaction between the user and the system when requesting key assignments, highlighting the change in error handling for key reuse.

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5f9af23 and b9ec1a5.

Files selected for processing (5)

• .changelog/v5.1.0/api-breaking/1995-deprecate-soft-opt-out.md (1 hunks)
• .changelog/v5.1.0/features/1995-deprecate-soft-opt-out.md (1 hunks)
• .changelog/v5.1.0/state-breaking/1995-deprecate-soft-opt-out.md (1 hunks)
• .changelog/v5.1.0/summary.md (1 hunks)
• CHANGELOG.md (1 hunks)

Files skipped from review due to trivial changes (2)

• .changelog/v5.1.0/features/1995-deprecate-soft-opt-out.md
• .changelog/v5.1.0/summary.md

Additional context used

Path-based instructions (1)

CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness. Please DO NOT report any missing or superfluous newlines, in particular at the end or beginning of files. Only report issues that you have a high degree of confidence in."

Additional comments not posted (9)

.changelog/v5.1.0/api-breaking/1995-deprecate-soft-opt-out.md (2)

1-1: LGTM!

The line correctly mentions the removal of the soft opt-out feature and references the relevant PR.

---

2-2: LGTM!

The line correctly mentions the backporting of another PR.

.changelog/v5.1.0/state-breaking/1995-deprecate-soft-opt-out.md (2)

1-1: LGTM!

The line correctly mentions the removal of the soft opt-out feature and references the relevant PR.

---

2-2: LGTM!

The line correctly mentions the backporting of another PR.

CHANGELOG.md (5)

3-11: Correctness and consistency check.

The lines correctly document the removal of the soft opt-out feature and reference the relevant PRs. The backporting information is accurate.

---

12-15: Correctness and consistency check.

The lines correctly document the changes in the Provider module and reference the relevant PR.

---

17-27: Correctness and consistency check.

The lines correctly document the dependency updates and reference the relevant PRs.

---

29-33: Correctness and consistency check.

The lines correctly document the removal of the soft opt-out feature and reference the relevant PRs.

---

35-51: Correctness and consistency check.

The lines correctly document the state-breaking changes and reference the relevant PRs.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.