Change extension readme with deprecation message#2337
Open
tharindulak wants to merge 4 commits into
Open
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds deprecation banners to BI and WSO2 Platform READMEs, simplifies the Hurl Client README start, and shows a runtime deprecation prompt in the WSO2 Platform extension that can open the WSO2 Integrator marketplace and record dismissal. ChangesExtension Deprecation Notices and Migration
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds deprecation messaging for the WSO2 Platform-related extensions, guiding users toward the WSO2 Integrator extension and cleaning up related README content.
Changes:
- Show a deprecation warning on WSO2 Platform extension activation with a link/action to install WSO2 Integrator.
- Add prominent deprecation banners to the WSO2 Platform and BI extension READMEs.
- Remove an outdated WSO2 Integrator-related note from the Hurl Client README.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| workspaces/wso2-platform/wso2-platform-extension/src/extension.ts | Adds an activation-time deprecation warning with an install call-to-action. |
| workspaces/wso2-platform/wso2-platform-extension/README.md | Adds a deprecation notice pointing users to WSO2 Integrator. |
| workspaces/hurl-client/hurl-client-extension/README.md | Removes an outdated statement tying the extension to WSO2 Integrator. |
| workspaces/bi/bi-extension/README.md | Adds a deprecation notice pointing users to WSO2 Integrator. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@workspaces/wso2-platform/wso2-platform-extension/src/extension.ts`:
- Around line 55-64: The deprecation warning is shown on every activation;
update the activation logic in extension.ts to store a flag in the extension's
Memento (use the activation context's globalState or workspaceState) and only
show the window.showWarningMessage if that flag is not set; present two buttons
(e.g., "Install WSO2 Integrator" and "Don't show again") and if the user clicks
"Don't show again" set a persistent key (like "wso2.deprecationDismissed") so
subsequent activations skip the prompt, and if they click the install button
open the marketplace URL as currently implemented.
- Line 62: The call to vscode.env.openExternal(vscode.Uri.parse(...)) can fail
or return false; update the call site to await the Thenable<boolean> from
vscode.env.openExternal and add error handling: wrap the await in a try/catch to
catch exceptions from malformed URIs or permission errors, check the returned
boolean and handle a false result, and report failures via
vscode.window.showErrorMessage and/or console.error so failures are surfaced;
look for the invocation of vscode.env.openExternal and vscode.Uri.parse in
extension.ts and replace the fire-and-forget call with an awaited call plus
try/catch and a false-result branch.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 31ecfa11-d6fc-414f-b2f0-d5597777eaed
📒 Files selected for processing (4)
workspaces/bi/bi-extension/README.mdworkspaces/hurl-client/hurl-client-extension/README.mdworkspaces/wso2-platform/wso2-platform-extension/README.mdworkspaces/wso2-platform/wso2-platform-extension/src/extension.ts
💤 Files with no reviewable changes (1)
- workspaces/hurl-client/hurl-client-extension/README.md
…option and error handling
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
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.
Purpose
Goals
Approach
UI Component Development
npm run storybookfrom the root directory to view current components.Manage Icons
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning
Summary by CodeRabbit
New Features
Documentation