Set FailIfPartitionMissing default to false and clarify documentation.

[MichalFrends1]

Dear PR creator, please select one of the PR templates, then remove others and this text.

---

Default PR template

Please review my changes :)

---

Task Update PR template

Review Checklist

• Task version updated (x.x.0)
• CHANGELOG.md updated
• Solution builds
• Warnings resolved (if possible)
• Typos resolved
• Tests cover new code
• Description how to run tests locally added to README.md (if needed)
• All tests pass locally

Summary by CodeRabbit

Release Notes - v1.2.0

• Changed

  • Modified default configuration for missing partition handling to provide more flexible behavior control in checkpoint operations.

• Documentation

  • Enhanced documentation clarifying partition handling behavior, including details on skipped partitions and their interaction with error handling settings.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

@MichalFrends1 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 13 minutes and 51 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Walkthrough

Version bump from 1.1.0 to 1.2.0 that sets FailIfPartitionMissing default to false via a DefaultValue attribute, expands its documentation for clarity on partition handling behavior, and updates the changelog accordingly.

Changes

Cohort / File(s)	Summary
Version bump Frends.AzureEventHub.UpdateCheckpoint/Frends.AzureEventHub.UpdateCheckpoint.csproj	Updated project version from 1.1.0 to 1.2.0
Changelog update Frends.AzureEventHub.UpdateCheckpoint/CHANGELOG.md	Added 1.2.0 entry documenting FailIfPartitionMissing default change and clarified documentation; removed 1.1.0 entry about metadata format switch
API metadata & documentation Frends.AzureEventHub.UpdateCheckpoint/.../Definitions/Options.cs	Added [DefaultValue(false)] attribute to FailIfPartitionMissing property and expanded XML documentation to clarify partition handling behavior and interaction with ThrowErrorOnFailure

Possibly related PRs

• change to metadata format, remove timestamp #23 — Implements the Azure Event Hubs metadata format change and removes TimestampAdjustment feature that this PR acknowledges in its changelog removal

Suggested reviewers

• jefim
• MatteoDelOmbra

Poem

🐰 A default now clear, set false with care,
Partitions missing? Handle with flair,
Documentation blooms, metadata shines,
Version bumps up—all signs align! ✨

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main changes: setting FailIfPartitionMissing default to false and clarifying documentation, which aligns with the code changes in Options.cs, CHANGELOG.md, and the version bump.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In @Frends.AzureEventHub.UpdateCheckpoint/CHANGELOG.md:
- Around line 3-8: Update the [1.2.0] changelog entry to include an explicit
upgrade note about the default change for FailIfPartitionMissing (e.g., “If you
relied on the previous default, set FailIfPartitionMissing=true explicitly.”)
and split the current single bullet into two bullets under "Changed": one
describing the behavior change for FailIfPartitionMissing (and its interaction
with ThrowErrorOnFailure and skipped partitions) and a separate bullet
describing the documentation/clarification updates.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9967b2d and b3ec757.

📒 Files selected for processing (3)

• Frends.AzureEventHub.UpdateCheckpoint/CHANGELOG.md
• Frends.AzureEventHub.UpdateCheckpoint/Frends.AzureEventHub.UpdateCheckpoint/Definitions/Options.cs
• Frends.AzureEventHub.UpdateCheckpoint/Frends.AzureEventHub.UpdateCheckpoint/Frends.AzureEventHub.UpdateCheckpoint.csproj

🧰 Additional context used

📓 Path-based instructions (3)

Frends.*/**/*.cs

⚙️ CodeRabbit configuration file

Frends.*/**/*.cs: Code must follow Microsoft C# coding standards, including:

• PascalCase for public members and task parameters
• Proper naming for abbreviations (Csv, Url, Api)
• Use of var only when type is obvious
• Clean structure and no unused code

Files:

• Frends.AzureEventHub.UpdateCheckpoint/Frends.AzureEventHub.UpdateCheckpoint/Definitions/Options.cs

Frends.*/Frends.*/*.csproj

⚙️ CodeRabbit configuration file

Frends.*/Frends.*/*.csproj: Ensure the .csproj targets .NET 6 or 8, uses the MIT license, and includes the following fields:

= Frends


= true
= MIT
Follow Microsoft C# project file conventions.

Files:

• Frends.AzureEventHub.UpdateCheckpoint/Frends.AzureEventHub.UpdateCheckpoint/Frends.AzureEventHub.UpdateCheckpoint.csproj

Frends.*/CHANGELOG.md

⚙️ CodeRabbit configuration file

Frends.*/CHANGELOG.md: Validate format against Keep a Changelog (https://keepachangelog.com/en/1.0.0/)
Include all functional changes and indicate breaking changes with upgrade notes.
Avoid notes like "refactored xyz" unless it affects functionality.

Files:

• Frends.AzureEventHub.UpdateCheckpoint/CHANGELOG.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Analyze (csharp)

🔇 Additional comments (2)

Frends.AzureEventHub.UpdateCheckpoint/Frends.AzureEventHub.UpdateCheckpoint/Definitions/Options.cs (1)

12-22: Good default wiring; please verify the new behavior description matches the implementation.

[DefaultValue(false)] plus = false is solid. The updated XML doc is very specific (skip + record error + continue, but overall unsuccessful and may throw based on ThrowErrorOnFailure, and partial updates may remain). Please double-check the implementation actually does all of that (especially “processing continues” and how failures are surfaced) so the docs don’t overpromise.

Frends.AzureEventHub.UpdateCheckpoint/Frends.AzureEventHub.UpdateCheckpoint/Frends.AzureEventHub.UpdateCheckpoint.csproj (1)

6-6: Confirm version bump aligns with your versioning policy for behavior-changing defaults.

If changing the default of FailIfPartitionMissing is considered breaking for existing users, ensure 1.2.0 is the intended bump (and that the changelog includes upgrade guidance).