Skip to content

Commit 35994fd

Browse files
committed
Updated source paths in docs_mapping.yaml to use ./influxdb3_plugins/ 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.
1 parent 76f0c34 commit 35994fd

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

.github/workflows/sync-plugins.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ jobs:
8383
run: |
8484
git clone --filter=blob:none --sparse https://github.com/influxdata/influxdb3_plugins.git influxdb3_plugins
8585
cd influxdb3_plugins
86-
git sparse-checkout set influxdata/ validate_readme.py
86+
git sparse-checkout set influxdata/ scripts/
8787
git checkout ${{ steps.inputs.outputs.source_commit }}
8888
8989
- name: Setup Node.js
@@ -118,10 +118,10 @@ jobs:
118118
# Run validation
119119
if [[ -n "$PLUGINS" ]]; then
120120
echo "Validating specific plugins: $PLUGINS"
121-
python validate_readme.py --plugins "$PLUGINS" 2>&1 | tee validation.log
121+
python scripts/validate_readme.py --plugins "$PLUGINS" 2>&1 | tee validation.log
122122
else
123123
echo "Validating all plugins"
124-
python validate_readme.py 2>&1 | tee validation.log
124+
python scripts/validate_readme.py 2>&1 | tee validation.log
125125
fi
126126
127127
# Check if validation passed

helper-scripts/influxdb3-plugins/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ For local testing and development:
3333
1. **Validate source content** (run from influxdb3_plugins directory):
3434
```bash
3535
cd /path/to/influxdb3_plugins
36-
python validate_readme.py
36+
python scripts/validate_readme.py
3737
```
3838

3939
2. **Transform content** (run from docs-v2 root directory):
@@ -323,7 +323,7 @@ Plugin documentation location:
323323
324324
## Phase 3: Automation Implementation
325325
326-
### 3.1 Validation Script (validate_readme.py)
326+
### 3.1 Validation Script (scripts/validate_readme.py)
327327
328328
```python
329329
#!/usr/bin/env python3
@@ -577,7 +577,7 @@ Plugin README change → Commit → Automatic comment with sync link
577577
578578
**Process**:
579579
1. **Parse request** - Extract plugin names and source commit from issue
580-
2. **Validate source** - Run `validate_readme.py` on specified plugins
580+
2. **Validate source** - Run `scripts/validate_readme.py` on specified plugins
581581
3. **Transform content** - Apply docs-v2 formatting and enhancements
582582
4. **Generate screenshots** - Capture Hugo-rendered plugin pages
583583
5. **Create PR** - Submit changes with comprehensive summary
@@ -595,7 +595,7 @@ Plugin README change → Commit → Automatic comment with sync link
595595
596596
### Step 1: Update Source README
597597
1. Edit README in `influxdb3_plugins/influxdata/[plugin]/`
598-
2. Run validation: `python validate_readme.py`
598+
2. Run validation: `python scripts/validate_readme.py`
599599
3. Fix any validation errors
600600
601601
### Step 2: Transform Content
@@ -635,7 +635,7 @@ Plugin README change → Commit → Automatic comment with sync link
635635
636636
Before merging any plugin documentation:
637637
638-
- [ ] Source README passes validation (`validate_readme.py`)
638+
- [ ] Source README passes validation (`scripts/validate_readme.py`)
639639
- [ ] All required sections present and properly formatted
640640
- [ ] At least 2 complete usage examples with expected output
641641
- [ ] All configuration parameters documented

0 commit comments

Comments
 (0)