feat: add What's New panel on extension update#2032
Draft
ralphstodomingo wants to merge 1 commit into
Draft
Conversation
Shows a curated in-editor "What's New" page in the center editor area (like VS Code's own Release Notes) after a minor or major version bump; patch releases stay silent. Content is fetched at runtime from a build-generated changelog manifest, so highlights update without shipping a new extension build. - `WhatsNewPanel` opens on demand or automatically on a minor/major upgrade, always persisting the seen version and deferring to the setup walkthrough on a fresh install. Fetches the manifest host-side with an offline cache fallback and emits a `whats_new_page_opened` event. - New `dbtPowerUser.showWhatsNew` command and `dbt.showChangelogOnUpdate` setting, plus a `dbt.whatsNewManifestUrl` override for testing. - React webview module renders the manifest grouped New -> Improved -> Fixed, with an "Also from Altimate AI" product sidebar and deep links to the website changelog; item and full-changelog clicks emit telemetry. - Uses the shared design system via `@altimateai/ui-components/lego` (`Spinner`) and its styles, wrapped in `al-tw-scope`. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01W1aQ62ZayCa3t4wk4ZpnFh
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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 |
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.
What
Adds a curated What's New page that opens in the center editor area — like VS Code's own Release Notes — the first time the extension activates after a minor or major version bump. Patch releases stay silent. Content is fetched at runtime from a build-generated changelog manifest, so highlights refresh without shipping a new extension build.
Implements the What's New product spec (a fresh take superseding the stale approach in #1914, which hand-authored static HTML and opened on any version change).
How it works
WhatsNewPanel(src/webview_provider/whatsNewPanel.ts) — a one-off editor-area webview. Auto-opens only on a minor/major upgrade (semver-gated), always persists the seen version so users aren't re-prompted, and defers to the setup walkthrough on a fresh install. Fetches the manifest host-side with an offline cache fallback.dbt Power User: Show What's New(dbtPowerUser.showWhatsNew) to reopen on demand;dbt.showChangelogOnUpdate(defaulttrue) to opt out of auto-open;dbt.whatsNewManifestUrlto point at a manifest for local/staging testing.webview_panels/src/modules/whatsNew/) renders the manifest grouped New → Improved → Fixed, with an "Also from Altimate AI" product sidebar and a contents rail. Entry titles deep-link tobase_url + anchoron the website changelog.whats_new_page_opened(version, items_shown, trigger),changelog_item_clicked(anchor, version, tag),full_changelog_clicked(version).@altimateai/ui-components/lego(Spinner) + ui-components styles underal-tw-scope, matching the same subpath-import pattern already used for@altimateai/ui-components/lineage.The manifest contract:
{ "product": "dbt-power-user", "version": "1.43.0", "generated_at": "...", "base_url": "https://www.altimate.ai/changelog", "items": [ { "title": "...", "tag": "new|improved|fix", "summary": "...", "anchor": "#..." } ] }A
sample-manifest.jsonis included for local rendering via thewhatsNewManifestUrloverride.Dependencies / gates
TODOinwhatsNewPanel.ts; overridable viadbt.whatsNewManifestUrluntil then.@altimateai/ui-components/legosubpath (theSpinnerre-export) ships inAltimateAI/altimate-frontend#2920;webview_panelsis pinned to0.0.87. Until that publishes, the webview build is verified locally via source-pointing to the frontend package.Verification
tsc -p ./— 0 errors; ESLint clean on changed files.vite buildclean — module + legoSpinnerbundle without resolution errors (verified against the source-pointed ui-components package).Draft — pending the manifest endpoint and the ui-components
0.0.87release.