Skip to content

Commit 769ea87

Browse files
committed
docs: Regenerate connector docs with fixed YAML quoting
Regenerated all connector documentation using fixed YAML serialization that properly quotes strings with special characters. Key fix: - Strings with newlines/whitespace now properly quoted (e.g., "\n\n", "\n") - Fixes misleading block scalar format (|+) that appeared empty - Also fixes other string values like "POST", "all", etc. Changes: - Updated to connector spec version 4.78.0 - Added OTLP gRPC/HTTP input/output connectors - Fixed YAML string quoting in both example files and field documentation - Updated whats-new.adoc with version 4.78.0 changes Uses @redpanda-data/docs-extensions-and-macros with QUOTE_DOUBLE fix applied to toYaml.js, renderLeafField.js, and renderConnectFields.js. This completely addresses the CodeRabbit issue from PR #362 where separators appeared as empty block scalars in the field documentation.
1 parent 91723b9 commit 769ea87

40 files changed

+73292
-117
lines changed

.github/workflows/update-docs.yml

Lines changed: 14 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -149,64 +149,26 @@ jobs:
149149
150150
rm -f full_output.txt pr_summary.txt
151151
152-
- name: Check for changes
153-
id: changes
154-
run: |
155-
if git diff --quiet && git diff --staged --quiet; then
156-
echo "has_changes=false" >> "$GITHUB_OUTPUT"
157-
echo "No changes detected"
158-
else
159-
echo "has_changes=true" >> "$GITHUB_OUTPUT"
160-
echo "Changes detected:"
161-
git status --short
162-
fi
163-
164-
- name: Commit and push changes
165-
if: steps.changes.outputs.has_changes == 'true'
166-
id: commit
167-
run: |
168-
git add -A
169-
170-
# Create commit message with timestamp for tracking
171-
TIMESTAMP=$(date -u +"%Y-%m-%d %H:%M UTC")
172-
git commit -m "docs: Update RPCN connector docs
173-
174-
Auto-generated at $TIMESTAMP"
175-
176-
# Push to the branch
177-
if git push origin $AUTO_BRANCH --force-with-lease; then
178-
echo "push_success=true" >> "$GITHUB_OUTPUT"
179-
else
180-
echo "push_success=false" >> "$GITHUB_OUTPUT"
181-
echo "Push failed - likely a concurrent update. Will retry."
182-
183-
# Fetch latest and try to rebase our commit
184-
git fetch origin $AUTO_BRANCH
185-
if git rebase origin/$AUTO_BRANCH; then
186-
git push origin $AUTO_BRANCH --force-with-lease
187-
echo "push_success=true" >> "$GITHUB_OUTPUT"
188-
else
189-
echo "push_success=false" >> "$GITHUB_OUTPUT"
190-
git rebase --abort
191-
fi
192-
fi
193-
194152
- name: Create or Update Pull Request
195-
if: steps.changes.outputs.has_changes == 'true' && steps.commit.outputs.push_success == 'true'
153+
if: success()
154+
id: create_pr
196155
uses: peter-evans/create-pull-request@v6
197156
with:
198157
token: ${{ env.ACTIONS_BOT_TOKEN }}
199158
base: main
200159
branch: ${{ env.AUTO_BRANCH }}
201160
title: 'auto-docs: Update RPCN connector docs'
202-
commit-message: 'docs: Update RPCN connector docs'
161+
commit-message: |
162+
docs: Update RPCN connector docs
163+
164+
Auto-generated at ${{ github.run_id }}
203165
body: |
204166
${{ steps.generate.outputs.delta_report }}
205167
206168
${{ steps.setup.outputs.has_manual_commits == 'true' && format('
207169
---
208170
209-
⚠️ **This PR contains manual commits that have been preserved:**
171+
WARNING: **This PR contains manual commits that have been preserved:**
210172
211173
```
212174
{0}
@@ -215,26 +177,14 @@ jobs:
215177
The automation has added new changes on top of these manual edits.
216178
', steps.setup.outputs.manual_commits) || '' }}
217179
labels: auto-docs
218-
# Don't delete branch on merge - let the normal PR process handle it
219180
delete-branch: false
220181

221-
- name: Handle no changes
222-
if: steps.changes.outputs.has_changes == 'false'
182+
- name: PR Result
183+
if: always()
223184
run: |
224-
echo "No documentation changes detected. This could mean:"
225-
echo "- The connector docs are already up to date"
226-
echo "- The generation produced identical output"
227-
echo ""
228-
if [ "${{ steps.setup.outputs.branch_exists }}" == "true" ]; then
229-
echo "Existing PR branch preserved with any manual changes intact."
185+
if [ "${{ steps.create_pr.outputs.pull-request-number }}" != "" ]; then
186+
echo "Created/Updated PR #${{ steps.create_pr.outputs.pull-request-number }}"
187+
echo "PR URL: ${{ steps.create_pr.outputs.pull-request-url }}"
188+
else
189+
echo "No PR created - no changes detected or branch up to date with main"
230190
fi
231-
232-
- name: Handle push failure
233-
if: steps.changes.outputs.has_changes == 'true' && steps.commit.outputs.push_success == 'false'
234-
run: |
235-
echo "::error::Failed to push changes after retry. This usually means:"
236-
echo "- Another automation run is in progress"
237-
echo "- There are unresolvable conflicts"
238-
echo ""
239-
echo "Manual intervention may be required."
240-
exit 1

antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ asciidoc:
1212
project-github: redpanda-data/connect
1313
full-version: 24.1.4
1414
latest-release-commit: b5ade3f40
15-
latest-connect-version: 4.77.0
15+
latest-connect-version: 4.78.0
1616
page-home-intro: >-
1717
Redpanda Connect is a data streaming service for building scalable, high-performance data pipelines that drive
1818
real-time analytics and actionable business insights. Integrate data across systems with hundreds of prebuilt

0 commit comments

Comments
 (0)