Skip to content

Conversation

@nberlee
Copy link

@nberlee nberlee commented Dec 16, 2025

Summary by CodeRabbit

Documentation

  • Substantially improved Azure Blob storage output documentation with comprehensive path templating guidance. Added detailed section explaining path template tokens including strftime directives, UUID values, tag references, and numeric placeholders. Enhanced with expanded practical examples demonstrating templated path configurations, best practices, and trailing-slash trimming behavior for improved user guidance and clarity.

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

@nberlee nberlee requested review from a team as code owners December 16, 2025 09:42
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 16, 2025

Walkthrough

The Azure Blob output documentation is updated to explain path templating features. The path parameter description is rewritten, a new "Path templating" section is added detailing available tokens and examples, and existing path examples are extended to demonstrate templated usage.

Changes

Cohort / File(s) Summary
Azure Blob Documentation
pipeline/outputs/azure_blob.md
Rewrote path parameter description to introduce path templating; added "Path templating" section documenting tokens (strftime directives, %3N, %9N/%L, $UUID, $TAG, $TAG[n]); extended examples showing templated paths and trailing-slash trimming behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • No code or functional changes; review focuses on documentation clarity and accuracy of examples

Poem

🐰 A template tale the rabbit spells,
With tokens jingling like garden bells,
Path variables dance in %strftime's delight,
$UUID and $TAG paint blobs just right!
📝✨

Pre-merge checks and finishing touches

✅ 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 clearly and concisely describes the main change: documentation of path templating support for the Azure Blob output plugin.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d261f6a and be354dd.

📒 Files selected for processing (1)
  • pipeline/outputs/azure_blob.md (1 hunks)
🔇 Additional comments (4)
pipeline/outputs/azure_blob.md (4)

28-28: Clear and actionable path parameter update.

The rewritten path parameter description effectively introduces the templating feature with a concrete example, properly references the new documentation section, and sets expectations about trailing slash handling. The example clearly demonstrates multiple token types working together.


48-50: Comprehensive introduction to templating behavior.

The section intro clearly explains template resolution, buffer persistence guarantees, and edge case handling (empty token expansion). The documentation of slice removal and path structure consistency is essential for users implementing buffering.


52-59: Well-documented token reference with helpful examples.

The token table is comprehensive, covering time-based tokens (strftime, milliseconds, nanoseconds), random identifiers (UUID), and tag-based expansion. The examples are clear and properly formatted, and the reference to record accessor limitations on line 59 appropriately flags potential gotchas for $TAG[n] users.


63-75: Accurate example with thoughtful explanation.

The YAML example effectively combines multiple token types and the accompanying explanation correctly traces token expansion (e.g., $TAG[0] and $TAG[4] components from the sample tag). The note about buffer persistence maintaining the same directory structure is valuable context for users implementing disk buffering. The example properly demonstrates how leading slashes are removed and the directory hierarchy is created as expected.


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

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

@eschabell
Copy link
Collaborator

@alexakreizinger requesting a review here from you. I'd like to see the config parameter table sorted alphabetically, but not a big deal, I'm working through the docs to standardize this and will get to this plugin eventually.

@eschabell eschabell added the waiting-on-review Waiting on a review from mainteners label Dec 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

waiting-on-code-merge waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants