Merge release/v2.4.0 to develop

[voxel51-bot]

Merge release/v2.4.0 to develop

Summary by CodeRabbit

• New Features
  • Added the ability to set a user-specific authentication header when making media queries in FiftyOne Teams 2.4.0
  • Enhances personalization and security of media query interactions

[coderabbitai]

Walkthrough

The pull request updates the release notes documentation for FiftyOne Teams version 2.4.0. It introduces a new section highlighting a feature enhancement that allows setting a user-specific authentication header when performing media queries. This change provides more personalized and secure media query interactions by enabling user-specific authentication mechanisms.

Changes

File	Change Summary
docs/source/release-notes.rst	Added release note for FiftyOne Teams 2.4.0, documenting the new ability to set user-specific authentication headers for media queries

Possibly related PRs

• updated release notes #5021: Previous release note update for FiftyOne Teams 2.1.2
• Merge v2.1.2 to develop #5023: Merging release notes for FiftyOne Teams 2.1.2 into develop branch
• Release notes #5307: Release note section for FiftyOne Teams 2.3.0

Suggested labels

documentation

Suggested reviewers

• findtopher

Poem

🐰 A rabbit's release note tale,
Authentication headers set sail,
Media queries now secure and bright,
User-specific headers take flight,
FiftyOne Teams, version two-point-four! 🔒

---

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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/source/release-notes.rst (1)

6-10: The release notes for v2.4.0 are well-formatted but could be more descriptive

The release notes for version 2.4.0 are concise but could benefit from additional details about:

• The impact and use cases for the new auth header feature
• Any breaking changes or migration steps needed
• Any dependencies or requirements for using the new feature

Consider expanding the release notes with:

 FiftyOne Teams 2.4.0
 --------------------
 *Released January 10, 2025*
 
-Added ability to set a user-specific auth header when making media queries.
+Added ability to set a user-specific authentication header when making media queries. This enhancement enables:
+- Per-user authentication for accessing protected media assets
+- Custom auth header values via the `set_auth_header()` method
+- Automatic header inclusion in all media requests
+
+Example usage:
+```python
+import fiftyone as fo
+dataset = fo.Dataset(...)
+dataset.set_auth_header("Bearer xyz123") 
+```

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 74944ea and e143463.

📒 Files selected for processing (1)

• docs/source/release-notes.rst (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build