Skip to content

Plan: options for retiring the deprecated Dashboard and Installer from CI, the solution and releases #6973

Closed

Description

@erikdarlingdata

Claude posting for Erik Darling.

The deprecated Dashboard and Installer still build and test on every PR, and shared-code changes still reach them:

The plan in #1262 is to deprecate the Dashboard, not remove it, so any change here is Erik's decision. This issue collects the options, each with its cost, what it saves, and what Dashboard and Installer users lose: for example, freezing a snapshot of the shared code the deprecated projects compile against, dropping them from PR CI, dropping them from the solution, no longer shipping them in releases, or removing them from the tree.

The options go in a comment here. Nothing under deprecated/, install/ or upgrades/ changes until Erik picks one.

Activity

  1. erikdarlingdata commented on Oct 31, 2026

    @erikdarlingdata
    OwnerAuthor

    Claude posting for Erik Darling.

    Options for #6973. Facts first, measured on origin/dev (d8503ec) and recent runs. Hours are my estimates. The decision is Erik's; the recommendation at the end is only that. Context is #1262 (deprecate the Dashboard, do not remove it).

    Facts

    1. Coupling. No linked source files and no shared props beyond the root Directory.Build.props and Directory.Packages.props (central versions; Installer.Core carries one VersionOverride). The coupling is ProjectReferences:

    Shared project .cs files Dashboard files that using it
    Common 157 101
    Ui 111 75
    Analysis 118 43
    Notifications 52 28
    PlanAnalysis 34 22
    Alerting 58 1

    Dashboard also references Installer.Core, which embeds install/**/*.sql (about 60 files) and upgrades/** (36 files) as resources. Five shared projects declare InternalsVisibleTo for PerformanceMonitorDashboard and Dashboard.Tests. Since 3.3.0 (Jul 29), 80 of 4,769 dev commits touched deprecated/ (55 in source, not tests or lock files) and 7 touched install/ or upgrades/.

    Tests outside deprecated/ that break or force edits when it changes:

    • Lite.Tests reads install/17, install/56, install/01 as reference SQL (CpuSchedulerStatsCollectorDefinitionTests, DmvResourceDatabaseSentinelTests, TestMapProducerGuardTests); PlanViewer4632FallbackTests reads the Dashboard theme.
    • Darling.Tests: AlertDeliveryChannelTests pins deprecated/Dashboard/Services/EmailAlertService.cs as a caller; LockedModeRestoreCoverageTests and ProductVersionDeclarationTests pin deprecated csproj paths; several census tests skip deprecated/ (harmless).
    • Inside the deprecated tree: Installer.Tests XeShredGateSqlTests reads install/ and pins the gate text (the pull behind the Shred an XE ring buffer when execution_count reads 0, so Managed Instance deadlocks and blocked processes are collected (#6868) #6870 copy); three Dashboard.Tests mirror tests read Dashboard sources; ThemeParityTests reads Lite's themes.

    2. CI. Nothing deprecated is built, packed or signed for a release. Steps that touch it: pr.yml (#6958, only when ci-plan.py says so), build.yml release job (restore, build, run), sql-validation.yml (only on install/**, 55-88 s per SQL version, 4 versions), plus path filters, ci-select.py areas and ci-plan.py outputs. nightly.yml builds none of it.

    Where Added time
    PR, Dashboard steps (restore 3 s, build 15 s, run 3 s) about 21 s, in a 6-7 min job
    PR, Installer steps about 5 s, only on install/Installer changes
    Release job (4 + 22 + 2 + 4 s) about 32 s
    How often on PRs 9 of the last 40 PR runs had the steps; 7 ran them

    A PR already spends about 170 runner-minutes (16 test legs). CI minutes are not the cost here.

    3. Releases and downloads. No release since v3.3.0 ships any deprecated asset (verified for 3.3.0 to 3.12.0). README and docs/editions.md say so and point at v3.2.0. Lifetime counts on the last releases that had them, beside Lite and Darling on the same page:

    Release Dashboard Setup / zip Installer zip Lite Setup Darling zip
    v3.0.0 112 / 123 129 n/a n/a
    v3.1.0 171 / 139 147 n/a n/a
    v3.2.0 42 / 54 49 87 206
    v3.9.0 to v3.12.0 none none 63, 89, 66, 2 1257, 1000, 193, 8

    (3.12.0 is hours old. Installer and Dashboard counts keep growing slowly on old pages.)

    4. Users. An existing Dashboard user keeps the 3.2.0 binaries and its upgrades/ scripts (last one is 3.0.0-to-3.1.0; two commits touched upgrades/ since 3.1). New servers use the 3.2.0 Installer zip. Docs say "existing installs keep working and remain on bug-fix support" (docs/editions.md). Shared-code fixes reach no Dashboard user today, because no binary has shipped since 3.2.0; only people building from source get them.

    5. Tooling. PerformanceMonitor.sln holds all 5 deprecated projects; CI restores and builds csprojs directly. ci-select.py has dashboard, installer, installer_core areas and suites (lines 274-294, 380-389, 560-563). release-checklist already says they are out of scope since v3.3.0 and keeps the schema rules for install//upgrades/. check-version-bump.yml falls back to the old Dashboard.csproj path on main.

    Options

    What changes Hours CI saved per PR Users lose Can break Undo
    O1 status quo Nothing 0 0 Nothing Shared changes keep breaking or forcing edits (#6935, #6954, #6870) n/a
    O2 freeze Copy 6 shared projects plus install/upgrades SQL under deprecated/ (or pin built DLLs), repoint refs, drop InternalsVisibleTo, delete the Lite/Darling/Installer test pins above, update filters 12-20 0 Shared fixes in Dashboard source builds About 530 duplicated files, lock files, sln name clashes Revert; shared fixes made meanwhile must be re-merged
    O3 out of PR CI Revert #6958's steps; run Dashboard/Installer tests in nightly.yml and the release job 2-3 0 to 21 s Nothing A break is found a day later; the copy-the-fix pull stays Revert
    O4 own solution New PerformanceMonitor.Deprecated.sln; remove 5 projects from main sln; fix the lock-file regenerate note and any sln-reading test 2 0 Nothing Tooling that reads the sln; Installer.Tests finds the repo root by PerformanceMonitor.sln (keep that name) Revert
    O5 stop shipping Already true since v3.3.0. Only the docs line "bug-fix support" would need rewording 0-1 0 Nothing Nothing n/a
    O6 remove Delete 5 projects, install/, upgrades/; edit sln, pr.yml, build.yml, sql-validation.yml, ci-select.py, ci-plan.py and its test, filters, 5 shared csprojs, README/docs/CONTRIBUTING, version-bump fallback; drop or rewrite the Lite/Darling test pins. Tag the last commit with the tree first 14-24 21 s on affected PRs, plus about 32 s per release Building the Dashboard from head (tag stays; v3.2.0 assets stay) Test pins missed; contradicts #1262 "do not remove" Revert the removal commit; the tag restores the tree

    Only O2 and O6 stop edits to deprecated files. O3 and O4 move when or where a break shows up. O5 is done.

    Recommendation (for Erik to decide)

    I recommend O6, on a date Erik names (the next release cut is a clean point), after tagging the last tree. Reasons: nothing ships from it (so removing it takes nothing from a binary user); CI time is negligible, so the real cost is the pull to edit dead code, which only O2 or O6 end; O2 costs about as much as O6 and leaves 530 duplicated files to carry. O6 needs Erik to amend the "do not remove" line in #1262 and the "bug-fix support" wording in docs/editions.md. If Erik wants to keep #1262 as written, take O2 and accept the higher cost. O3 plus O4 are cheap and reversible, but would not have stopped #6870.

  2. erikdarlingdata commented on Oct 31, 2026

    @erikdarlingdata
    OwnerAuthor

    Claude posting for Erik Darling.

    Decision: freeze the Dashboard and Installer source into one zip, deprecated/dashboard-installer-source.zip, and remove the live projects from the solution, CI and tests. This replaces O2 and O6.

    • Stays: install/ and upgrades/, because Darling's projects and tests read them. Changelog and CI history files also stay.
    • Removed: the five projects under deprecated/, their CI steps and path filters, the parts of Lite and Darling tests that read a Dashboard or Installer copy, and packages that only those projects used.
    • Docs point to the zip. A short deprecated/README.md explains what the zip holds and how to build from it.

    One PR on fix/6973-freeze-deprecated-zip.

  3. erikdarlingdata commented on Oct 31, 2026

    @erikdarlingdata
    OwnerAuthor

    Claude posting for Erik Darling. Fixed on dev by #6992 (3bb5bed).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions