docs: document IN_SANDBOX → OPEN limitation (Issue #136), README polish, SonarQube/Cloud rename#157
Merged
okorach-sonar merged 3 commits intoMay 8, 2026
Conversation
… OPEN (Issue #136) SonarQube 2025+ introduces an IN_SANDBOX issue status for issues raised by sandboxed AI rules that haven't yet been promoted to the standard catalog. SonarCloud has no equivalent state, so the migrator leaves these issues in their default OPEN state on the destination — assignment, comments, and tags still sync. Document this as a known limitation in two places so users who notice the status change post-migration can find the explanation: - docs/troubleshooting.md: new section "Source Issues in IN_SANDBOX Are Migrated as OPEN" alongside the existing "Issue Counts Differ" entry. - docs/key-capabilities.md: extend Section 7's status-mapping list to call out IN_SANDBOX explicitly, with a link to the troubleshooting doc. No code change — this is purely behaviour we cannot fix on the SonarCloud side. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Tighten the README opener: - "self-hosted SonarQube" → "self-hosted SonarQube Server" / "SonarQube Cloud" to use the modern product names consistently. - "copies everything" → "migrates everything" to match the rest of the doc. - Drop the "This was done by reverse-engineering..." sentence from the lead paragraph; the reverse-engineering story is covered in detail in docs/key-capabilities.md Section 2. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…Cloud across all docs Apply the modern product names consistently across README.md and every file under docs/ — including CHANGELOG.md, scenario guides, troubleshooting, architecture, configuration, and the rest. Mechanical rename via Perl with negative-lookahead regexes that protect compound terms and identifiers: SonarQube(?! Server\b)(?! Cloud\b)(?![A-Za-z0-9_]) → SonarQube Server SonarCloud(?![A-Za-z0-9_]) → SonarQube Cloud What this preserves untouched: - Camel-case identifiers: SonarQubeClient, SonarCloudClient, createSonarCloudClient, VersionAwareSonarQubeClient. - URLs: sonarcloud.io, sonarqube.us, sonarqube.org. - Already-correct compounds: "SonarQube Server", "SonarQube Cloud". - Lowercase strings (env var names, package keys). Follow-up cleanup pass: collapsed duplicate phrasing introduced by the rename, where "SonarQube server" used "server" as a descriptive noun. Reduced "SonarQube Server server" → "SonarQube Server" in 11 spots. Out of scope: - Source code identifiers and string literals (CLI/log output, error messages) are unchanged. CLAUDE.md, DESIGN.md, and the regression-sample README are also untouched. - Anchor-link slugs (#sonarqube-...) — none in the existing docs, so no cross-reference breakage. 25 files changed, 641 insertions(+), 641 deletions(-). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
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.
Summary
Closes #136. Documentation-only PR with three commits:
581942c— Document IN_SANDBOX → OPEN limitation (Issue Document that source issues in IN_SANDBOX state are migrated to OPEN state #136). SonarQube Server 2025+ introduces theIN_SANDBOXissue status (sandboxed AI rules). SonarQube Cloud has no equivalent state, so the migrator leaves these issuesOPENon the destination. Added a section indocs/troubleshooting.mdand a note indocs/key-capabilities.mdSection 7's status-mapping list. No code change — there is no SonarQube Cloud transition that maps toIN_SANDBOX.1bca622— Polish README intro wording. Tighten the lead paragraph: use modern product names ("SonarQube Server"/"SonarQube Cloud"), say "migrates" instead of "copies", and drop the reverse-engineering sentence (still covered indocs/key-capabilities.mdSection 2).6d71b25— Global rename across docs. RenameSonarQube→SonarQube ServerandSonarCloud→SonarQube CloudacrossREADME.mdand every file underdocs/. Mechanical Perl pass with negative-lookahead regexes that preserve identifiers (SonarQubeClient,createSonarCloudClient,VersionAwareSonarQubeClient), URLs (sonarcloud.io,sonarqube.us), already-correct compounds, and lowercase strings. Follow-up cleanup collapsed 11 "SonarQube Server server" duplications back to "SonarQube Server".25 files / 641 lines changed in commit 3.
Test plan
grepconfirms no nakedSonarQubeorSonarCloudreferences remain inREADME.md/docs/*.md(only compound terms, code identifiers, and URLs).grepconfirms noSonarQube Server Server/SonarQube Cloud Cloudartifacts.🤖 Generated with Claude Code
Note
Low Risk
Documentation-only updates that do not affect runtime behavior; main risk is minor confusion from terminology/compatibility wording changes.
Overview
Updates documentation to consistently use current product naming (SonarQube Server and SonarQube Cloud) across
README.mdand thedocs/set, including examples, tables, and error taxonomy references.Adds/clarifies migration guidance: documents that source issues in
IN_SANDBOX(SQ Server 2025+) are migrated asOPENbecause SQC has no equivalent transition, and updates the README to state supported SonarQube Server version compatibility (9.9+ with tested ranges noted).Reviewed by Cursor Bugbot for commit 6d71b25. Bugbot is set up for automated code reviews on this repo. Configure here.