Skip to content

Fix dashboard terminal documentation link - #20230

Merged
Mitch Denny (mitchdenny) merged 1 commit into
mainfrom
mitchdenny-fix-terminal-documentation-link
Sep 18, 2026
Merged

Mitch Denny (mitchdenny) merged 1 commit into
mainfrom
mitchdenny-fix-terminal-documentation-link

Conversation

@mitchdenny

Copy link
Copy Markdown
Member

Description

Correct the terminal dock's More information link to point to the intended terminal documentation.

  • Before: https://aka.ms/aspire/dashboard-terminals
  • After: https://aka.ms/aspire/dashboard-terminal

Update the existing component test assertion to match. The focused WatchUpdates_ReplaceSnapshotAndSelectAppHostTerminals test passes (1 test), and no references to the incorrect URL remain.

Fixes # (issue)

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: ad3e0bea-59ee-4c43-9bfa-31743aee3d11
@github-actions

Copy link
Copy Markdown
Contributor

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 20230

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 20230"

@github-actions

Copy link
Copy Markdown
Contributor

Tests selector

10 / 99 PR test projects · 3 PR jobs, from 2 changed files.

Selected PR test projects (10 / 99)

Aspire.Cli.EndToEnd.Tests, Aspire.Dashboard.Components.Tests, Aspire.Dashboard.Tests, Aspire.Hosting.DotnetTool.Tests, Aspire.Hosting.JavaScript.Tests, Aspire.Hosting.RemoteHost.Tests, Aspire.Hosting.Testing.Tests, Aspire.Managed.Tests, Aspire.Playground.Tests, Aspire.Templates.Tests

Selected PR jobs (3)

cli-starter-validation, extension-e2e, polyglot


How these were chosen — grouped by what changed

⚠️ 7 of the 10 selected test projects come from a single change — src/Aspire.Dashboard/Components/Layout/TerminalDock.razor.

🔧 src/Aspire.Dashboard/Components/Layout/TerminalDock.razor (changed source)
→ 7 via the project graph: Aspire.Dashboard.Tests, Aspire.Hosting.DotnetTool.Tests (2 hops), Aspire.Hosting.JavaScript.Tests, Aspire.Hosting.RemoteHost.Tests (2 hops), Aspire.Hosting.Testing.Tests, Aspire.Managed.Tests (2 hops), Aspire.Playground.Tests (2 hops)

📦 affected project Aspire.Dashboard
→ 1 test: Aspire.Templates.Tests

📦 affected project Aspire.Managed
→ 1 test: Aspire.Cli.EndToEnd.Tests

🧪 tests/Aspire.Dashboard.Components.Tests/Layout/TerminalDockTests.cs (changed test)
→ 1 directly: Aspire.Dashboard.Components.Tests

Job reasons

Job Triggered by
cli-starter-validation affected project Aspire.Managed
extension-e2e • src/Aspire.Dashboard/Components/Layout/TerminalDock.razor
• affected project Aspire.Dashboard
polyglot affected project Aspire.Managed

Selection computed for commit 5c7679e.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The implementation and focused test are consistent and complete.

Review effort: Balanced
Findings: None

What changed in this PR

Corrects the dashboard terminal help link and updates its regression test.

Changes:

  • Changes the documentation URL to the intended singular path.
  • Updates the component test assertion.
File Description
src/​Aspire.Dashboard/​Components/​Layout/​TerminalDock.razor Corrects the terminal documentation link.
tests/​Aspire.Dashboard.Components.Tests/​Layout/​TerminalDockTests.cs Verifies the corrected URL.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

@github-actions

Copy link
Copy Markdown
Contributor

Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt.

@mitchdenny
Mitch Denny (mitchdenny) merged commit b477bdd into main Sep 18, 2026
437 of 440 checks passed
@mitchdenny
Mitch Denny (mitchdenny) deleted the mitchdenny-fix-terminal-documentation-link branch September 18, 2026 10:57
@github-actions github-actions Bot added this to the 13.6 milestone Sep 18, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor

✅ No documentation update needed.

Step 5 branch taken: docs_optional -> internal_refactor

Triggered signals: none (signal_count: 0 in .pr-docs-check/signals.json; recommendation: "docs_optional").

Why internal_refactor fits: Both changed files are under src/ and tests/:

  • src/Aspire.Dashboard/Components/Layout/TerminalDock.razor - one-line change to the href of the terminal dock's "More information" link, correcting (aka.ms/redacted) to (aka.ms/redacted)
  • tests/Aspire.Dashboard.Components.Tests/Layout/TerminalDockTests.cs - matching one-line update to the test assertion for the new URL.

No new or changed public types, methods, options, or resource strings are introduced - only the destination of an existing external aka.ms redirect link changes. The PR title/body confirm this is purely a link fix ("Correct the terminal dock's More information link to point to the intended terminal documentation").

Docs-site check: Searched src/frontend/src/content/docs/ for both the old and new aka.ms/aspire/dashboard-terminal* URLs and for any reference to the dashboard terminal dock's "More information" link - no matches found. The aspire.dev docs site does not link to or mention this URL, so there is no documentation page to update for this change.

No docs PR is needed.

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ CI Failure Analysis: Possible Flaky Test(s)

The CI build failed due to test failure(s) that appear unrelated to the PR changes. These may be flaky tests.

Suspected flaky test(s):

  • Aspire.Hosting.Tests.Pipelines.DistributedApplicationPipelineTests.WithPipelineStepFactory_MultipleStepsSyncOverload_ExecutesAllSteps in job Tests / No-package tests (collection, Aspire.Hosting.Tests, Hosting-4, Hosting-4, tests/Aspire.Hosting.Te... / Hosting-4 (windows-latest)
    • Error: System.InvalidOperationException : Step 'destroy' failed: Access to the path is denied.
      ---- System.UnauthorizedAccessException : Access to the path is denied.
    • Stack Trace (first frames):
at Aspire.Hosting.Pipelines.DistributedApplicationPipeline.ExecuteStepAsync(PipelineStep step, PipelineStepContext stepContext) in /_/src/Aspire.Hosting/Pipelines/DistributedApplicationPipeline.cs:line 1108
   at Aspire.Hosting.Pipelines.DistributedApplicationPipeline.<>c__DisplayClass24_0.<<ExecuteStepsAsTaskDag>g__ExecuteStepWithDependencies|0>d.MoveNext() in /_/src/Aspire.Hosting/Pipelines/DistributedApplicationPipeline.cs:line 869
--- End of stack trace from previous location ---
   at Aspire.Hosting.Pipelines.DistributedApplicationPipeline.ExecuteStepsAsTaskDag(List`1 steps, Dictionary`2 stepsByName, PipelineContext context) in /_/src/Aspire.Hosting/Pipelines/DistributedApplicationPipeline.cs:line 907
at Aspire.Hosting.Docker.Tests.DockerComposeTests.DeployWithDashboard_PrintsDashboardAndServiceEndpoints() in /home/runner/work/aspire/aspire/tests/Aspire.Hosting.Docker.Tests/DockerComposeTests.cs:line 460
   at Aspire.Hosting.Docker.Tests.DockerComposeTests.DeployWithDashboard_PrintsDashboardAndServiceEndpoints() in /home/runner/work/aspire/aspire/tests/Aspire.Hosting.Docker.Tests/DockerComposeTests.cs:line 500
  • Why likely flaky: 'docker compose up' fails intermittently in the CI environment (image pulls/registry contention), leaving no dashboard/service endpoints for the assertion to find. Unrelated to the PR's dashboard terminal documentation change. Matches known prior cause docker-compose-port-already-in-use (issue [CI Failure] Flaky: DockerComposeTests.DeployWithDashboard_PrintsDashboardAndServiceEndpoints fails due to port already in use #18719, 4 prior occurrences).
  • Aspire.Hosting.Azure.Tests.AzureServiceBusExtensionsTests.AzureServiceBusEmulatorResourceGeneratesConfigJsonOnlyChangedProperties in job Tests / No-package tests (regular, Aspire.Hosting.Azure.Tests, Hosting.Azure, Hosting.Azure, tests/Aspire... / Hosting.Azure (ubuntu-latest)
    • Error: System.Threading.Tasks.TaskCanceledException : A task was canceled.
    • Stack Trace (first frames):
at Microsoft.Extensions.Hosting.Internal.Host.ForeachService[T](IEnumerable`1 services, CancellationToken token, Boolean concurrent, Boolean abortOnFirstException, List`1 exceptions, Func`3 operation)
   at Microsoft.Extensions.Hosting.Internal.Host.StopAsync(CancellationToken cancellationToken)
   at Aspire.Hosting.DistributedApplication.StopAsync(CancellationToken cancellationToken) in /_/src/Aspire.Hosting/DistributedApplication.cs:line 497
   at Aspire.Hosting.Azure.Tests.AzureServiceBusExtensionsTests.AzureServiceBusEmulatorResourceGeneratesConfigJsonOnlyChangedProperties() in /home/runner/work/aspire/aspire/tests/Aspire.Hosting.Azure.Tests/AzureServiceBusExtensionsTests.cs:line 499
  1. Error: EBUSY: resource busy or locked, rmdir 'C:\Users\runneradmin\AppData\Local\Temp\aev-XZUHyl\workspace.e2e-dynamic-debug\first'
  • Stack Trace (first frames):
AggregateError: Dynamic debug configuration E2E teardown failed.
1. Error: EBUSY: resource busy or locked, rmdir 'C:\Users\runneradmin\AppData\Local\Temp\aev-XZUHyl\workspace\.e2e-dynamic-debug\first'
    at runE2eTeardown (out\test-e2e\test-e2e\helpers\fixtures.js:217:15)
    at async Context.<anonymous> (out\test-e2e\test-e2e\dynamicDebugConfiguration.e2e.test.js:62:9)

Suggested actions:

  • Re-run the failed CI jobs to confirm if the failure is intermittent
  • If the test continues to fail, consider quarantining it using /quarantine-test <test name> <issue URL>
  • Search existing issues to see if this test is already known to be flaky

You can re-run the failed jobs from the workflow run page.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants