Automate plugin documentation sync workflow between influxdb3_plugins and docs-v2 #6329
+1,725
−1
Conversation
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
- Add GitHub Actions workflow for syncing plugin docs from influxdb3_plugins - Create issue template for triggering sync requests - Add Node.js transformation script (port_to_docs.js) with ES modules - Add mapping configuration (docs_mapping.yaml) for all official plugins - Add npm scripts for plugin sync operations - Include comprehensive documentation in helper-scripts/influxdb3-plugins/README.md The workflow provides: - Issue-triggered automation with no cross-repo secrets required - Validation of source READMEs against template requirements - Content transformation with Hugo shortcodes and GitHub URLs - Screenshot generation for visual validation - Automatic PR creation with detailed change summaries
… instead of ../influxdb3_plugins/ to match what the GitHub Actions workflow expects when it clones the repository: 1. GitHub Actions workflow clones to ./influxdb3_plugins/ 2. docs_mapping.yaml references ./influxdb3_plugins/influxdata/[plugin]/README.md 3. Local development can manually clone the repo to the same location for testing Tupdated all the source paths in docs_mapping.yaml to use ./influxdb3_plugins/ instead of ../influxdb3_plugins/. This now matches exactly what the GitHub Actions workflow expects when it clones the repository. The paths are now consistent: 1. GitHub Actions workflow clones to ./influxdb3_plugins/ 2. docs_mapping.yaml references ./influxdb3_plugins/influxdata/[plugin]/README.md 3. Local development can manually clone the repo to the same location for testing This resolves the inconsistency and makes the automation more reliable. For local development, developers would just need to run: git clone https://github.com/influxdata/influxdb3_plugins.git From the docs-v2 root directory, and then they can use the same paths that the automation uses.
There was a problem hiding this comment.
Pull Request Overview
This PR implements a hybrid manual-automated workflow for synchronizing plugin documentation between the influxdb3_plugins repository and docs-v2. The workflow enables automatic transformation of plugin READMEs while maintaining consistency and validation across both repositories.
Key changes include:
- GitHub Actions workflow for issue-triggered plugin documentation sync
- Node.js transformation script with comprehensive content processing
- Mapping configuration for all official InfluxDB 3 plugins
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Adds npm scripts for plugin sync operations with ES module support |
| helper-scripts/influxdb3-plugins/port_to_docs.js | Core transformation script that converts plugin READMEs to docs-v2 format |
| helper-scripts/influxdb3-plugins/docs_mapping.yaml | Configuration mapping all official plugins from source to target paths |
| helper-scripts/influxdb3-plugins/README.md | Comprehensive documentation of the sync workflow and usage instructions |
| .github/workflows/sync-plugins.yml | GitHub Actions workflow for automated plugin documentation synchronization |
| .github/ISSUE_TEMPLATE/sync-plugin-docs.yml | Issue template for triggering plugin sync requests |
… instead of ../influxdb3_plugins/ to match what the GitHub Actions workflow expects when it clones the repository: 1. GitHub Actions workflow clones to ./influxdb3_plugins/ 2. docs_mapping.yaml references ./influxdb3_plugins/influxdata/[plugin]/README.md 3. Local development can manually clone the repo to the same location for testing Tupdated all the source paths in docs_mapping.yaml to use ./influxdb3_plugins/ instead of ../influxdb3_plugins/. This now matches exactly what the GitHub Actions workflow expects when it clones the repository. The paths are now consistent: 1. GitHub Actions workflow clones to ./influxdb3_plugins/ 2. docs_mapping.yaml references ./influxdb3_plugins/influxdata/[plugin]/README.md 3. Local development can manually clone the repo to the same location for testing This resolves the inconsistency and makes the automation more reliable. For local development, developers would just need to run: git clone https://github.com/influxdata/influxdb3_plugins.git From the docs-v2 root directory, and then they can use the same paths that the automation uses.
* fix: update workflow branch references from master to main * fix: update issue template branch references from master to main - Update sync-plugin-docs.yml description (line 40) - Update placeholder from 'master' to 'main' (line 41) - Update default value from 'master' to 'main' (line 42) - Add influxdb3_plugins/ to .gitignore - Ensures template matches influxdb3_plugins default branch * Update .gitignore --------- Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
jstirnaman
commented
Oct 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This is a hybrid manual-automated workflow for syncing README.md changes from influxdb3_plugins repo to docs-v2 InfluxDB 3 Core and Enterprise Plugins Library.
In docs-v2 (this PR):
The workflow provides:
See the counterpart PR influxdata/influxdb3_plugins#26