feat: Add Bloblang method and function reference partials#402
Merged
JakeSCahill merged 12 commits intomainfrom Apr 2, 2026
Merged
feat: Add Bloblang method and function reference partials#402JakeSCahill merged 12 commits intomainfrom
JakeSCahill merged 12 commits intomainfrom
Conversation
✅ Deploy Preview for redpanda-connect ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedToo many files! This PR contains 300 files, which is 150 over the limit of 150. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (300)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
JakeSCahill
force-pushed
the
feat/add-bloblang-docs
branch
from
493d4fd to
c3fb25d
Compare
Adds auto-generated partials for all Bloblang methods and functions, with manual descriptions added as a stop-gap until benthos PR is merged. Changes: - Updated GitHub workflow to include --include-bloblang flag - Generated partials for 193 Bloblang methods - Generated partials for 41 Bloblang functions - Added manual descriptions to 67 methods missing descriptions - Regenerated connector partials with latest automation The Bloblang partials are now available in: - modules/components/partials/bloblang-methods/ - modules/components/partials/bloblang-functions/ Manual descriptions will be replaced with auto-generated ones once benthos PR #414 is merged and released. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
JakeSCahill
force-pushed
the
feat/add-bloblang-docs
branch
6 times, most recently
from
f50d363 to
c207868
Compare
Regenerated all Bloblang method and function partials with: - Proper bloblang syntax highlighting (replaced coffeescript) - Parameters section with clean table format - Support for optional parameter indicators - Lead-in prose extracted from summaries (not embedded as comments) - Fixed HTML entity escaping in descriptions Uses @redpanda-data/docs-extensions-and-macros@4.15.8 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Regenerated all Bloblang method and function partials with: - Proper bloblang syntax highlighting (replaced coffeescript) - Parameters section with clean AsciiDoc table format - Support for optional parameter indicators - Lead-in prose extracted from summaries (ending with colons) - Fixed HTML entity escaping in descriptions Uses @redpanda-data/docs-extensions-and-macros@4.15.8 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Manually added top-level descriptions to 67 Bloblang methods that were missing them. These descriptions match the descriptions added to the benthos repository in PR #414 and will be automatically picked up when the next version of Redpanda Connect is released. Methods updated: - Type coercion: array, bool, not_null, number, timestamp, type - Object & Array: all, any, append, collapse, contains, enumerated, exists, explode, filter, find, find_all, find_by, find_all_by, flatten, fold, index, keys, key_values, length, map_each, map_each_key, merge, assign, not_empty, sort, sort_by, slice, sum, unique, values, without - String manipulation: bytes, capitalize, encode, decode, encrypt_aes, decrypt_aes, escape_html, index_of, unescape_html, escape_url_query, unescape_url_query, escape_url_path, unescape_url_path, filepath_join, filepath_split, format, has_prefix, has_suffix, hash, uuid_v5, join, uppercase, lowercase, parse_csv, parse_logfmt, parse_json, parse_yaml, format_yaml, format_json, reverse, quote, unquote, replace, replace_all, replace_many, replace_all_many, re_find_all, re_find_all_submatch, re_find_object, re_find_all_object, re_match, re_replace, re_replace_all, split, string, trim, trim_prefix, trim_suffix, repeat Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Adds WARNING admonition blocks to the 8 deprecated timestamp-related Bloblang methods. The deprecation notice appears after the title and before the description, keeping descriptions outside the warning block. Deprecated methods: - format_timestamp - format_timestamp_strftime - format_timestamp_unix - format_timestamp_unix_micro - format_timestamp_unix_milli - format_timestamp_unix_nano - parse_timestamp - parse_timestamp_strptime This ensures readers are properly notified when using deprecated Bloblang functionality while preserving the manually added descriptions from the previous commit. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
JakeSCahill
force-pushed
the
feat/add-bloblang-docs
branch
from
c207868 to
fd02393
Compare
Fixes include directives to use proper Antora resource ID format with component name. Before: include::redpanda-connect:partial$bloblang-functions/... After: include::redpanda-connect:components:partial$bloblang-functions/... This resolves "Unresolved include directive" build errors. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Fixes "section title out of sequence" warnings by converting Markdown- style headings (##### ) to proper AsciiDoc H4 headings (==== ). Fixed partials: - explode.adoc (lines 22, 34) - filter.adoc (line 30) - map_each.adoc (lines 22, 38) This resolves build warnings about expected level 4 headings vs level 6. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Remove redundant '== Functions' category heading from functions.adoc - Keep functions at leveloffset=+1 to make each function an H2 heading - Methods page retains its category structure with leveloffset=+2
- Auto-generate methods.adoc and functions.adoc using new templates - Apply sentence case to category headings in methods.adoc - Categories now alphabetically sorted (General first, Deprecated last) - All partials regenerated with latest extension updates Changes include: - 'String Manipulation' -> 'String manipulation' - 'JSON Web Tokens' -> 'JSON web tokens' - 'Object & Array Manipulation' -> 'Object & array manipulation' - Preserved: 'SQL', 'GeoIP' (acronyms and product names)
Feediver1
approved these changes
Apr 2, 2026
Regenerate 31 Bloblang method and function partials with cleaner parameter notation: Before: | `name`^*^ ^*^ Optional parameter After: | `name` (optional) This is simpler, more direct, and avoids AsciiDoc footnote rendering complexity. The (optional) suffix is clearer at a glance.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds auto-generated AsciiDoc partials for all Bloblang methods and functions, enabling them to be included in documentation pages.
Changes
GitHub Workflow
.github/workflows/update-docs.ymlto include--include-bloblangflagGenerated Partials
modules/components/partials/bloblang-methods/modules/components/partials/bloblang-functions/Each partial includes:
Manual Descriptions (Stop-Gap)
Added manual descriptions to 67 methods that were missing them in the source:
These match descriptions added in redpanda-data/benthos#414 and will be replaced with auto-generated ones once that PR is merged and released.
Usage
Partials can be included in documentation pages:
```asciidoc
include::components:partial$bloblang-methods/capitalize.adoc[]
include::components:partial$bloblang-functions/uuid_v4.adoc[]
```
Next Steps
modules/guides/pages/bloblang/methods.adocandfunctions.adocto use these partials🤖 Generated with Claude Code