Skip to content

Updated path in README sync automation#398

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

Updated path in README sync automation#398
mikeromard wants to merge 1 commit 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
Copy link
Copy Markdown

PR Reviewer Guide 🔍

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

Premature Configuration Update 🟠 [major]

The PR description indicates that the repository restructuring in snyk/user-docs is scheduled for May 28. Merging this PR before that date (currently May 22) will cause the workflow to fail during the cp command, as the file at the new SOURCE_PATH will not yet exist in the source repository. This will interrupt the automated documentation synchronization process.

SOURCE_PATH: ./docs/developer-tools/snyk-ide-plugins-and-extensions/eclipse-plugin/README.md
Broken Regex Match 🟠 [major]

The move from docs/developer-tools/... to developer-tools/... reduces the directory depth of the README file. Standard GitBook relative paths to assets (which are mapped in this PR to developer-tools/.gitbook/assets) would change from ../../../.gitbook/assets/ to ../../.gitbook/assets/. The sed command still searches for the old ../../../ pattern, which will result in no matches and leave broken relative links in the generated README.

-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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants