Fix terminal API surface by sebastienros · Pull Request #18978 · microsoft/aspire

Sébastien Ros (sebastienros) · 2026-08-03T23:15:00Z

Description

The terminal API review found that orchestration and Unix domain socket implementation types were leaking into the public Aspire.Hosting surface. This change keeps TerminalAnnotation, TerminalHostResource, and TerminalHostLayout internal while preserving terminal configuration through WithTerminal and TerminalOptions.

TerminalOptions now carries the same ASPIRETERMINAL001 experimental diagnostic as WithTerminal, so direct use of the supporting configuration type is guarded consistently. Public XML documentation no longer links to the internal terminal host resource, and focused tests cover the intended visibility and diagnostic metadata.

User-facing usage

Terminal configuration remains available through the existing experimental API:

builder.AddExecutable("agent", "my-agent", ".")
    .WithTerminal(options =>
    {
        options.Columns = 200;
        options.Rows = 50;
    });

Validation:

dotnet test --project tests/Aspire.Hosting.Tests/Aspire.Hosting.Tests.csproj --no-launch-profile -- --filter-class "*.WithTerminalTests" --filter-not-trait "quarantined=true" --filter-not-trait "outerloop=true" (23 passed)

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

Keep terminal orchestration implementation types internal and mark TerminalOptions with the same experimental diagnostic as WithTerminal. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: ae2398ed-a4d8-423d-bf69-3a04bbf6c54f

github-actions · 2026-08-03T23:15:11Z

🚀 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 -- 18978

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 18978"

github-actions · 2026-08-03T23:18:02Z

Tests selector (audit mode)

The full test matrix and all jobs still run in audit mode. The tests and jobs below are what selective CI would run under enforcement.

48 / 100 test projects · 4 jobs, from 5 changed files.

Selected test projects (48 / 100)

Aspire.EndToEnd.Tests, Aspire.Hosting.Analyzers.Tests, Aspire.Hosting.Azure.Kubernetes.Tests, Aspire.Hosting.Azure.Kusto.Tests, Aspire.Hosting.Azure.Tests, Aspire.Hosting.Blazor.Tests, Aspire.Hosting.Browsers.Tests, Aspire.Hosting.CodeGeneration.Go.Tests, Aspire.Hosting.CodeGeneration.Java.Tests, Aspire.Hosting.CodeGeneration.Python.Tests, Aspire.Hosting.CodeGeneration.Rust.Tests, Aspire.Hosting.CodeGeneration.TypeScript.Tests, Aspire.Hosting.Containers.Tests, Aspire.Hosting.DevTunnels.Tests, Aspire.Hosting.Docker.Tests, Aspire.Hosting.Dotnet.Tests, Aspire.Hosting.DotnetTool.Tests, Aspire.Hosting.EntityFrameworkCore.Tests, Aspire.Hosting.Foundry.Tests, Aspire.Hosting.Garnet.Tests, Aspire.Hosting.GitHub.Models.Tests, Aspire.Hosting.Go.Tests, Aspire.Hosting.JavaScript.Tests, Aspire.Hosting.Kafka.Tests, Aspire.Hosting.Keycloak.Tests, Aspire.Hosting.Kubernetes.Tests, Aspire.Hosting.Maui.Tests, Aspire.Hosting.Milvus.Tests, Aspire.Hosting.MongoDB.Tests, Aspire.Hosting.MySql.Tests, Aspire.Hosting.Nats.Tests, Aspire.Hosting.OpenAI.Tests, Aspire.Hosting.Oracle.Tests, Aspire.Hosting.Orleans.Tests, Aspire.Hosting.PostgreSQL.Tests, Aspire.Hosting.Python.Tests, Aspire.Hosting.Qdrant.Tests, Aspire.Hosting.RabbitMQ.Tests, Aspire.Hosting.Radius.Tests, Aspire.Hosting.Redis.Tests, Aspire.Hosting.RemoteHost.Tests, Aspire.Hosting.Seq.Tests, Aspire.Hosting.SqlServer.Tests, Aspire.Hosting.Testing.Tests, Aspire.Hosting.Tests, Aspire.Hosting.Valkey.Tests, Aspire.Hosting.Yarp.Tests, Aspire.Playground.Tests

Selected jobs (4)

deployment-e2e, extension-e2e, polyglot, typescript-api-compat

How these were chosen — grouped by what changed

⚠️ 43 of the 48 selected test projects come from a single change — src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs.

🔧 src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs (changed source)
→ 43 via the project graph

show 43

Aspire.Hosting.Analyzers.Tests (2 hops), Aspire.Hosting.Azure.Kubernetes.Tests (2 hops), Aspire.Hosting.Azure.Kusto.Tests (2 hops), Aspire.Hosting.Azure.Tests, Aspire.Hosting.Browsers.Tests (2 hops), Aspire.Hosting.CodeGeneration.Go.Tests, Aspire.Hosting.CodeGeneration.Java.Tests, Aspire.Hosting.CodeGeneration.Python.Tests, Aspire.Hosting.CodeGeneration.Rust.Tests, Aspire.Hosting.CodeGeneration.TypeScript.Tests, Aspire.Hosting.Containers.Tests (2 hops), Aspire.Hosting.DevTunnels.Tests (2 hops), Aspire.Hosting.Docker.Tests (2 hops), Aspire.Hosting.DotnetTool.Tests (2 hops), Aspire.Hosting.EntityFrameworkCore.Tests (2 hops), Aspire.Hosting.Foundry.Tests (2 hops), Aspire.Hosting.Garnet.Tests (2 hops), Aspire.Hosting.GitHub.Models.Tests (2 hops), Aspire.Hosting.Go.Tests (2 hops), Aspire.Hosting.JavaScript.Tests (2 hops), Aspire.Hosting.Kafka.Tests (2 hops), Aspire.Hosting.Keycloak.Tests (2 hops), Aspire.Hosting.Kubernetes.Tests (2 hops), Aspire.Hosting.Maui.Tests, Aspire.Hosting.Milvus.Tests (2 hops), Aspire.Hosting.MongoDB.Tests (2 hops), Aspire.Hosting.MySql.Tests (2 hops), Aspire.Hosting.Nats.Tests (2 hops), Aspire.Hosting.OpenAI.Tests (2 hops), Aspire.Hosting.Oracle.Tests (2 hops), Aspire.Hosting.Orleans.Tests (2 hops), Aspire.Hosting.PostgreSQL.Tests (2 hops), Aspire.Hosting.Python.Tests (2 hops), Aspire.Hosting.Qdrant.Tests (2 hops), Aspire.Hosting.RabbitMQ.Tests (2 hops), Aspire.Hosting.Redis.Tests (2 hops), Aspire.Hosting.RemoteHost.Tests, Aspire.Hosting.Seq.Tests (2 hops), Aspire.Hosting.SqlServer.Tests (2 hops), Aspire.Hosting.Testing.Tests (2 hops), Aspire.Hosting.Valkey.Tests (2 hops), Aspire.Hosting.Yarp.Tests (2 hops), Aspire.Playground.Tests

🧪 tests/Aspire.Hosting.Tests/WithTerminalTests.cs (changed test)
→ 1 directly: Aspire.Hosting.Tests
→ 3 via the project graph: Aspire.Hosting.Blazor.Tests, Aspire.Hosting.Dotnet.Tests, Aspire.Hosting.Radius.Tests

📦 affected project Aspire.Hosting
→ 1 test: Aspire.EndToEnd.Tests

Job reasons

Job	Triggered by
`deployment-e2e`	affected project `Aspire.Hosting.Azure`
`extension-e2e`	• `src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs`, `src/Aspire.Hosting/ApplicationModel/TerminalHostLayout.cs`, `src/Aspire.Hosting/ApplicationModel/TerminalHostResource.cs`, `src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs` • affected project `Aspire.Hosting`
`polyglot`	affected project `Aspire.Hosting.Go`
`typescript-api-compat`	affected project `Aspire.Hosting`

Selection computed for commit 8a15316.

Copilot

Pull request overview

Keeps terminal implementation details internal while retaining the experimental public terminal configuration API.

Changes:

Internalizes terminal annotation, host resource, and socket-layout types.
Marks TerminalOptions with ASPIRETERMINAL001.
Updates XML documentation and adds API-surface tests.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
`src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs`	Internalizes the annotation and marks options experimental.
`src/Aspire.Hosting/ApplicationModel/TerminalHostLayout.cs`	Internalizes terminal socket-layout details.
`src/Aspire.Hosting/ApplicationModel/TerminalHostResource.cs`	Internalizes the terminal host resource.
`src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs`	Removes public documentation links to internal types.
`tests/Aspire.Hosting.Tests/WithTerminalTests.cs`	Verifies visibility and experimental metadata.

github-actions · 2026-08-04T00:08:08Z

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

Mitch Denny (mitchdenny) · 2026-08-04T11:50:07Z

Agree. I think it is good to keep this internal for now. I have a few other fixes to merge on top of this one.

Copilot AI review requested due to automatic review settings August 3, 2026 23:15

Sébastien Ros (sebastienros) requested review from James Newton-King (JamesNK), David Negstad (danegsta), David Fowler (davidfowl), Karol Zadora-Przylecki (karolz-ms) and Mitch Denny (mitchdenny) as code owners August 3, 2026 23:15

github-actions Bot added the area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication label Aug 3, 2026

Copilot started reviewing on behalf of Sébastien Ros (sebastienros) August 3, 2026 23:16 View session

Copilot AI reviewed Aug 3, 2026

View reviewed changes

Sébastien Ros (sebastienros) marked this pull request as draft August 3, 2026 23:18

Sébastien Ros (sebastienros) marked this pull request as ready for review August 4, 2026 00:16

Mitch Denny (mitchdenny) approved these changes Aug 4, 2026

View reviewed changes

Mitch Denny (mitchdenny) merged commit f57f062 into main Aug 4, 2026
679 of 682 checks passed

Mitch Denny (mitchdenny) deleted the sebros/fix-terminal-api-surface branch August 4, 2026 11:50

github-actions Bot added this to the 13.5 milestone Aug 4, 2026

github-actions Bot mentioned this pull request Aug 4, 2026

[repo-pulse] 📊 Repo Pulse — Daily Activity Dashboard #16404

Open

David Pine (IEvangelist) mentioned this pull request Aug 6, 2026

PR Documentation Check fails to create docs PRs for release branches #19054

Open

50 tasks

Jose Perez Rodriguez (joperezr) mentioned this pull request Aug 6, 2026

Publishing a Go/Python app with a user-supplied Dockerfile silently drops the tool-invocation prefix #19070

Open

Navigation Menu

Uh oh!

Fix terminal API surface - #18978

Fix terminal API surface#18978
Mitch Denny (mitchdenny) merged 1 commit into
mainfrom
sebros/fix-terminal-api-surface

Sébastien Ros (sebastienros) commented Aug 3, 2026

Uh oh!

github-actions Bot commented Aug 3, 2026

Uh oh!

github-actions Bot commented Aug 3, 2026

Job reasons

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented Aug 4, 2026

Uh oh!

Mitch Denny (mitchdenny) commented Aug 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Sébastien Ros (sebastienros) commented Aug 3, 2026

Description

User-facing usage

Checklist

Uh oh!

github-actions Bot commented Aug 3, 2026

Uh oh!

github-actions Bot commented Aug 3, 2026

Tests selector (audit mode)

Selected test projects (48 / 100)

Selected jobs (4)

Job reasons

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

github-actions Bot commented Aug 4, 2026

Uh oh!

Mitch Denny (mitchdenny) commented Aug 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants