-
Notifications
You must be signed in to change notification settings - Fork 321
Jmercer/complete plugin sync fix #6527
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
jstirnaman
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question related to the level 1 heading comment in the other PR.
| cd .ext/influxdb3_plugins | ||
| git sparse-checkout set influxdata/ scripts/ | ||
| git checkout ${{ steps.inputs.outputs.source_commit }} | ||
| uses: actions/checkout@v4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🥇
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see in this script where it removes the top-level heading from the README.
Fix plugin documentation sync automation
Summary
This PR fixes critical issues in the plugin documentation sync workflow that prevented it from running end-to-end. The workflow can now successfully authenticate across repositories, locate source files, transform plugin documentation, and build the Hugo site.
Problems Solved
1. Cross-Repository Authentication
Issue: Default
GITHUB_TOKENlacks permissions to access files from other repositories, causing 403 errors when attempting to cloneinfluxdb3_pluginsfrom thedocs-v2workflow.2. Incorrect Path Resolution in Transformation Script
Issue: The transformation script (
port_to_docs.js) reads source paths fromdocs_mapping.yaml, not from theINFLUXDB3_PLUGINS_PATHenvironment variable. The configured paths used../../.ext/influxdb3_pluginsbut the actual directory structure requires../../../.ext/influxdb3_plugins.Testing
Tested with workflow run using plugin
basic_transformation:Results:
Related Work
This PR builds on:
PLUGINS_CONTENT_READ_TOKENandISSUES_READ_WRITE_TOKEN)Impact
Before this PR:
After this PR:
Future Improvements
docs-v2nesting (would require changes across workflow)How to Test
jmercer/complete-plugin-sync-fixbasic_transformationmainChecklist
cc: @jstirnaman