Updated path in README sync automation#398
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
|
|
This comment has been minimized.
This comment has been minimized.
PR Reviewer Guide 🔍
|
AI Review: snyk-eclipse-plugin #398 — Updated path in README sync automation (re-review)Verdict: approved — no Critical blockers. Change 1 (line 55):
|
bastiandoetsch
left a comment
There was a problem hiding this comment.
SOURCE_PATH double-docs fix is correct. Sed path consistent with new SOURCE_PATH; README has no images so sed is currently a no-op. — AI review
| cp $SOURCE_PATH ./$DESTINATION_REPOSITORY/$FILE_TO_COMMIT | ||
| sed -i \ | ||
| -e "s|../../../.gitbook/assets/|https://github.com/snyk/user-docs/raw/HEAD/docs/.gitbook/assets/|g" \ | ||
| -e "s|../../../.gitbook/assets/|https://github.com/snyk/user-docs/raw/HEAD/developer-tools/.gitbook/assets/|g" \ |
There was a problem hiding this comment.
ℹ️ Suggestion · non-blocking
The replacement URL here is correct — I verified against snyk/user-docs@HEAD: .../raw/HEAD/developer-tools/.gitbook/assets/ returns 200 while the repo-root variant (.../raw/HEAD/.gitbook/assets/) is 404. Assets genuinely live under developer-tools/.
But the match pattern on the left (../../../.gitbook/assets/, three ../) wasn't adjusted for the same relocation. Now that SOURCE_PATH drops the extra docs/ level, the synced README sits at developer-tools/snyk-ide-plugins-and-extensions/eclipse-plugin/README.md, so a relative asset link from it resolves at ../../.gitbook/assets/ (two ../, matching the sibling docs in that directory). The three-../ prefix no longer matches, so this rewrite will silently no-op.
No impact today — the current README contains zero .gitbook/assets image references, so sed finds nothing either way. But if an image is ever added (siblings already have them), the link will 404 on github.com. Consider dropping one ../ → s|../../.gitbook/assets/|...|g.
Note: this readme-sync.yml is copied across the other IDE plugin repos (per the header comment); the same two-line correction likely applies there too.
— AI review
Description
This PR is to update the README sync automation to account for the new paths introduced in the user-docs repo with the new site architecture. The source file is moving from
docs/developer-tools/snyk-ide-plugins-and-extensions/eclipse-plugin/README.mdtodeveloper-tools/snyk-ide-plugins-and-extensions/eclipse-plugin/README.mdon May 28.Checklist
Screenshots / GIFs
Visuals that may help the reviewer. Please add screenshots for any UI change. GIFs are most welcome!