Repository navigation
docs_gen: write the release's connector data into the docs asset - #4947
Open
JakeSCahill wants to merge 1 commit into
Open
JakeSCahill wants to merge 1 commit into
JakeSCahill wants to merge 1 commit into
Conversation
With -version, docs_gen also writes attachments/connect-<version>.json: the json-full schema with cloudSupported and requiresCgo on every component and config object, and cloudOnly on components only Redpanda Cloud runs. The release job passes the tag's version and date, so the Bloblang playground and other site tools get the data with the release instead of from a separate regeneration in rp-connect-docs.
JakeSCahill
added a commit
to redpanda-data/docs-extensions-and-macros
that referenced
this pull request
Oct 14, 2026
…371) redpanda-data/connect#4947 adds `modules/components/attachments/connect-<version>.json` to the Connect docs asset. The extension now adds files under `attachments/` as attachments of the `connect` component's `components` module, so the site serves `/connect/components/_attachments/connect-<version>.json` from the release itself. A file that rp-connect-docs already commits wins, as for partials. Its committed file has the previous version's name, though, so both are added, and `set-available-attachment-versions` points the Bloblang playground at the newest. A test covers that path end to end. Assets without the file (v4.113.0 and older) behave as before.
This branch has not been deployed
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
1 participant
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.
The docs site's
connect-<version>.json(read by the Bloblang playground and other site tools) is still built outside this repo: rp-connect-docs' auto-docs job runsrpk connect list --format json-fullon the release binaries, adds Cloud and cgo flags by comparing binaries, and commits the file. It's a second source of truth for the same data, and it lags each release until that job runs.With
-version, docs_gen now writesattachments/connect-<version>.jsoninto the docs asset:list --format json-fullprints, with the version and date.cloudSupportedandrequiresCgoon every component and config object, from the same platform data ascatalog.json.cloudOnlyon components only Redpanda Cloud runs. They're found the way cgo-only components are: components that a standard build ofallcomponentsregisters and theredpanda-connectbinary doesn't (a2a_messagetoday).The release job passes the tag's version and its commit date, and the layout check requires the file. A
docs_tagrerun of a tag whose docs_gen predates the flag gets the partials only.Compared with the committed 4.112.0 file, every
cloudSupported,requiresCgo, andcloudOnlyflag matches for all shared components. The differences:sap_hanaandtimeplusare new in 4.113.0, rate limits gain their description, anda2a_messageloses an unusedreasonfield.PR CI doesn't pass
-version, so PRs are unchanged. This conflicts with the release.yml split in #4938; whichever merges second is rebased.