Skip to content

feat: add What's New panel on extension update#2032

Draft
ralphstodomingo wants to merge 1 commit into
masterfrom
feat/whats-new-panel
Draft

feat: add What's New panel on extension update#2032
ralphstodomingo wants to merge 1 commit into
masterfrom
feat/whats-new-panel

Conversation

@ralphstodomingo

Copy link
Copy Markdown
Contributor

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.
  • Command + settingsdbt Power User: Show What's New (dbtPowerUser.showWhatsNew) to reopen on demand; dbt.showChangelogOnUpdate (default true) to opt out of auto-open; dbt.whatsNewManifestUrl to point at a manifest for local/staging testing.
  • Webview module (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 to base_url + anchor on the website changelog.
  • Telemetrywhats_new_page_opened (version, items_shown, trigger), changelog_item_clicked (anchor, version, tag), full_changelog_clicked (version).
  • Design system — uses @altimateai/ui-components/lego (Spinner) + ui-components styles under al-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.json is included for local rendering via the whatsNewManifestUrl override.

Dependencies / gates

  • Manifest endpoint (Comm Center). The fetch URL is a placeholder pending the Comm Center IDE-manifest endpoint + keying (per-version file vs single feed). Marked TODO in whatsNewPanel.ts; overridable via dbt.whatsNewManifestUrl until then.
  • ui-components release. The @altimateai/ui-components/lego subpath (the Spinner re-export) ships in AltimateAI/altimate-frontend#2920; webview_panels is pinned to 0.0.87. Until that publishes, the webview build is verified locally via source-pointing to the frontend package.

Verification

  • Extension backend tsc -p ./ — 0 errors; ESLint clean on changed files.
  • Webview vite build clean — module + lego Spinner bundle without resolution errors (verified against the source-pointed ui-components package).
  • Full in-editor render (before/after screenshots) to follow once the manifest endpoint or sample-serving is wired for E2E.

Draft — pending the manifest endpoint and the ui-components 0.0.87 release.

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
@ralphstodomingo ralphstodomingo self-assigned this Jul 8, 2026
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 545189e3-a7d0-4dd7-b3ff-7037eea14dfd

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/whats-new-panel

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

1 participant