Skip to content

Updated path in README sync automation#398

Open
mikeromard wants to merge 2 commits into
mainfrom
chore/update-docs-path-in-readme-sync
Open

Updated path in README sync automation#398
mikeromard wants to merge 2 commits into
mainfrom
chore/update-docs-path-in-readme-sync

Conversation

@mikeromard
Copy link
Copy Markdown
Collaborator

@mikeromard mikeromard commented May 21, 2026

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.md to developer-tools/snyk-ide-plugins-and-extensions/eclipse-plugin/README.md on May 28.

Checklist

Screenshots / GIFs

Visuals that may help the reviewer. Please add screenshots for any UI change. GIFs are most welcome!

@snyk-io
Copy link
Copy Markdown

snyk-io Bot commented May 21, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 21, 2026

CLA assistant check
All committers have signed the CLA.

@mikeromard mikeromard marked this pull request as ready for review May 22, 2026 12:10
@mikeromard mikeromard requested a review from a team as a code owner May 22, 2026 12:10
@snyk-pr-review-bot

This comment has been minimized.

@snyk-pr-review-bot
Copy link
Copy Markdown

PR Reviewer Guide 🔍

🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Incorrect Path Depth 🟠 [major]

The sed search pattern ../../../.gitbook/assets/ is incorrect for the new directory structure. According to the PR description, the file moved from docs/developer-tools/snyk-ide-plugins-and-extensions/eclipse-plugin/README.md to developer-tools/snyk-ide-plugins-and-extensions/eclipse-plugin/README.md. This move reduces the directory depth by one level. If the assets are now in developer-tools/.gitbook/assets/ (as implied by the replacement URL), the relative path in the source markdown is now ../../.gitbook/assets/. The current regex will fail to find any matches, causing image links in the synchronized README to remain as relative paths that won't resolve on GitHub.

-e "s|../../../.gitbook/assets/|https://github.com/snyk/user-docs/raw/HEAD/developer-tools/.gitbook/assets/|g" \
📚 Repository Context Analyzed

This review considered 4 relevant code sections from 4 files (average relevance: 0.72)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants