Skip to content

Regenerate API data from Aspire 13.6.0 staging build f4c27f2d - #1787

Merged
David Pine (IEvangelist) merged 3 commits into
release/13.6from
ievangelist-13-6-documentation-coverage
Sep 29, 2026
Merged

David Pine (IEvangelist) merged 3 commits into
release/13.6from
ievangelist-13-6-documentation-coverage

Conversation

@IEvangelist

@IEvangelist David Pine (IEvangelist) commented Sep 28, 2026 •

Copy link
Copy Markdown
Member

Follow-up to #1780, which merged with two open checkboxes. Both are now validated against the latest staging build.

This is a single commit on top of the current release/13.6 tip (5589ce6d), so it merges cleanly.

  • Generated API catalog refreshed from genuine 13.6 packages, including the late WithRepl additions and removed attributes.
  • REPL samples and all other new samples checked against the real 13.6 SDK, not stale Twoslash types.

Provenance

  • Feed: darc-pub-microsoft-aspire-f4c27f2d (https://pkgs.dev.azure.com/dnceng/public/_packaging/darc-pub-microsoft-aspire-f4c27f2d/nuget/v3/index.json).
  • Source: microsoft/aspire release/13.6 at f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62, the newest staging build. Every regenerated official TS module records sourceCommit: f4c27f2d…, and the restored nuspecs (for example Redis, Blazor and CodeGeneration.TypeScript) report that commit.
  • Versions: stable packages are 13.6.0; prerelease packages are 13.6.0-preview.1.26478.8. The codegen package is Aspire.Hosting.CodeGeneration.TypeScript 13.6.0, mapped exclusively to the staging feed. nuget.org has no 13.6.0, so resolution is unambiguous.
  • Scanner: a locally fixed CLI/ATS scanner, built from a11eca96 plus 320eed42 (the Fix duplicate inherited ATS method exports aspire#20438 content) and 435fd4eb (the [release/13.6] Fix duplicate inherited ATS method exports aspire#20443 content). Both upstream PRs are still unmerged.
  • Isolation: the stable version number didn't change between builds, so generation used fresh process-local NUGET_PACKAGES, HTTP cache, TEMP and ASPIRE_HOME folders. That rules out reusing e8fd6fbb bits. ASPIRE_REPO_ROOT and ASPIRE_REPO_PATH were unset, and there was no source-project substitution.
  • Pipeline: the repo's own pipeline, in this order: update:integrations → generate-package-json.ps1 → normalize:api-data -- --pkgs → update:ts-api (with Twoslash .d.ts) → validate:api-data.
    • Generated JSON and d.ts were not hand-edited, and nothing from 14.x was imported.

Deviation: no ASPIRE_RELEASE_VERSION pin

Pinning 13.6.0 left the 50 prerelease packages stale. The feed is commit-specific, so the unpinned run resolves every package from the same build.

Packages absent from the feed

These seven official packages aren't in this build, so they are carried forward unchanged:

  • Aspire.Elastic.Clients.Elasticsearch 13.3.0
  • Aspire.Hosting.AgentFramework.DevUI 1.22.0-preview.260918.1
  • Aspire.Hosting.AWS 13.7.2
  • Aspire.Hosting.ClickHouse 13.5.3
  • Aspire.Hosting.DocumentDB 0.116.0
  • Aspire.Hosting.Elasticsearch 13.3.0
  • Aspire.Hosting.GitHub.Models 13.5.4

Changes

  • Generated data: regenerated aspire-integrations.json (still 217 packages; 82 at 13.6.0 and 50 at 13.6.0-preview.1.26478.8), pkgs/ (210 succeeded, 0 failed), ts-modules/ (146 succeeded, 0 failed) and twoslash/aspire.d.ts. integration-docs.json needed no change.
  • Generator fix (generate-package-json.ps1): the 24 Provisioning overlays restored Aspire.Hosting at the overlay's own prerelease version, which doesn't exist now that Aspire.Hosting is stable 13.6.0. The script now uses the resolved Aspire.Hosting version, via a new -HostingVersion parameter with a feed-lookup fallback for selective runs.
  • Blazor docs: AddDotnetProjectBlazorGateway and WithBlazorClientApp report their own ASPIREDOTNETPROJECT001 diagnostic. ASPIREBLAZOR001 applies to other experimental Blazor hosting types, such as BlazorWasmAppResource.
  • Dashboard docs ([release/13.6] Remove dashboard terminal navigation entry points aspire#20562): the dashboard no longer has a terminal button in the header or a terminal entry in the mobile menu.
    • dashboard/explore.mdx and the What's new bullet now describe the backtick key as the way to open and hide the terminal dock.

Validation

  • WithRepl coverage: present in the C# and TS API data for all six REPL packages (PostgreSQL, MySql, MongoDB, SqlServer, Redis, Valkey) and in aspire.d.ts.
  • C# compile: every new sample compiles with 0 warnings and 0 errors against exact packages from the f4c27f2d feed (16 at 13.6.0, 9 at 26478.8). This covers REPL×6, Rust, ConnectorNamespace, Foundry Toolbox, Radius, CSI, Helm, Blazor (now matching [docs] Document DotnetProjectResource-backed Blazor gateway APIs for polyglot AppHosts #1564's WithExternalHttpEndpoints sample), Provisioning and Dotnet. The Dotnet samples need no ASPIREDOTNETPROJECT001 suppression.
  • TS compile: the SDK was generated by a real aspire restore (codegen 13.6.0, Aspire.Hosting.Redis/13.6.0 and Aspire.Hosting.Blazor/13.6.0-preview.1.26478.8, all at f4c27f2d). Strict tsc (NodeNext) passes for all 18 .mts samples, including the new Blazor gateway TS sample. A negative control (withReplz) fails with TS2551.
  • Scanner warnings:
    • Radius reports no collisions; the earlier withContainerImage collision on CSharpAppResource is gone.
    • The createRoleAssignment overload collisions remain in 16 Provisioning overlays. They are recorded here, not suppressed; no doc sample calls this method.
  • Tests: pnpm validate:api-data passes (217 identities, 146 modules matched to C# provenance). These suites pass: test:unit:structured-data (82), api-reference (55), api-markdown (30), ts-api (31), twoslash-types (12), twoslash-blocks (2), llms-txt (12) and docs (2).
  • No local pnpm build was run; CI covers it.

Not done

  • Contributors: update:release-contributors needs the v13.6.0 tag, which doesn't exist yet. This is left for after the release is tagged.

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1787. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1787 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

Regenerate the integration catalog, C# package API JSON, TypeScript API
modules, and Twoslash types from the darc-pub-microsoft-aspire-f4c27f2d
staging feed (microsoft/aspire release/13.6 f4c27f2d, Aspire 13.6.0 and
13.6.0-preview.1.26478.8) with a locally fixed ATS scanner.

Fix the package JSON generator so Provisioning overlays restore the
resolved Aspire.Hosting version instead of their own prerelease version.
Correct the Blazor gateway diagnostic aside, and describe the backtick
shortcut as the way to open the dashboard terminal dock now that its
navigation entry points are removed (microsoft/aspire#20562).

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@IEvangelist
David Pine (IEvangelist) force-pushed the ievangelist-13-6-documentation-coverage branch from 399d998 to 2e9fa1d Compare September 29, 2026 04:27
@IEvangelist David Pine (IEvangelist) changed the title Regenerate API data from the Aspire 13.6.0 staging feed Regenerate API data from Aspire 13.6.0 staging build f4c27f2d Sep 29, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@IEvangelist
David Pine (IEvangelist) marked this pull request as ready for review September 29, 2026 13:55
Copilot AI balanced review requested due to automatic review settings September 29, 2026 13:55

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

🟡 Changes recommended

Selective generation can restore provisioning overlays against the feed’s latest Hosting version instead of the catalog-pinned version.

Review effort: Balanced
Findings: 1 High severity

Open (1)
What changed in this PR

Refreshes Aspire 13.6 API reference data from staging build f4c27f2d and aligns related documentation.

Changes:

  • Regenerates C#, TypeScript, and Twoslash API data, including six WithRepl APIs.
  • Updates Blazor diagnostic and dashboard terminal documentation.
  • Adjusts provisioning-overlay restore handling.
File Description
src/​tools/​PackageJsonGenerator/​generate-package-json.ps1 Resolves a separate Hosting version for provisioning overlays.
src/​frontend/​src/​data/​aspire-integrations.json Refreshes package versions and download counts.
src/​frontend/​src/​data/​pkgs/​*.json (127 files) Refreshes C# API metadata and provenance.
src/​frontend/​src/​data/​ts-modules/​*.json (87 files) Refreshes TypeScript API metadata and exports.
src/​frontend/​src/​data/​twoslash/​aspire.d.ts Updates consolidated TypeScript declarations.
src/​frontend/​src/​content/​docs/​integrations/​dotnet/​blazor-hosting.mdx Corrects experimental diagnostic guidance.
src/​frontend/​src/​content/​docs/​whats-new/​aspire-13-6.mdx Updates terminal dock navigation guidance.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/tools/PackageJsonGenerator/generate-package-json.ps1
David Pine (IEvangelist) added a commit that referenced this pull request Sep 29, 2026
… its types

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
…ng overlay restores

Addresses review feedback: use the catalog's Aspire.Hosting version before falling back to the latest feed version.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@IEvangelist
David Pine (IEvangelist) merged commit b9b7bc7 into release/13.6 Sep 29, 2026
17 checks passed
@IEvangelist
David Pine (IEvangelist) deleted the ievangelist-13-6-documentation-coverage branch September 29, 2026 15:03
David Pine (IEvangelist) added a commit that referenced this pull request Sep 29, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
David Pine (IEvangelist) added a commit that referenced this pull request Sep 29, 2026
Completes the in-progress `aspire-13-6.mdx` draft by adding the
remaining "Ship Mode" / changelog highlights, without removing any
previously approved content.

## What's added
- **Dashboard:** Native AOT standalone dashboard + Fluent UI Blazor v5
refresh.
- **Integrations:** docked database/cache REPLs (`WithRepl()`), remote
Foundry Local services (`RunAsFoundryLocal(endpoint)`), Cosmos DB
emulator OpenTelemetry.
- **App model:** multithreaded coordinated builds, Project V2 migration
skill for agents.
- **CLI:** pin the CLI via a local tool manifest
(`AspireCliInvocationMode`), MCP config now opt-in in `aspire
new`/`init`.
- **VS Code:** outdated-CLI warning.
- Reworked the "This release introduces" list into a high-level summary
rather than a section-by-section table of contents.

## Update: TODOs and review feedback addressed

- **Merged `release/13.6`** (42 commits, including #1780 and #1684).
When resolving conflicts, I kept this PR's summary list and emoji
headings and took the release branch's corrected facts: .NET project
graduation, `-mt` SDK requirements, and the Blazor gateway publish
support. I kept the Project V2 migration skill and Remote Foundry Local
bullets.
- **All TODOs resolved; the article now has none:**
- Connector Namespace (#1781): links to
`/integrations/cloud/azure/azure-connector-namespace/`.
- Connection-string naming (#1782): links to
`/fundamentals/environment-variables/#migrating-connection-string-consumers`.
  - Foundry Toolbox (#1628): links to the Toolbox walkthrough.
- Docked REPLs (#1777): links to the per-integration **Open an
interactive REPL** sections. The six REPL anchors were broken
(`#add-*-with-a-repl-command`) and are fixed to
`#open-an-interactive-repl`.
- Java (@marshalhayes): added an `addSpringBootApp` / `AddSpringBootApp`
sample, taken from the package README.
- Rust (@afscrome): used the reviewer's
`addRustApp(...).withHttpEndpoint({ env: 'PORT' })` sample.
- **Twoslash:** every TypeScript AppHost fence is now `twoslash`. New
TypeScript-first tabs cover `withRepl`, `withTerminal`, `addRustApp`,
`addSpringBootApp`, `withBuildEnvironment`, `addDenoApp`, and
`addToolbox`.
- **Preview note:** added a "Prerelease packages" note. Java, Rust,
Connector Namespace, and Sandboxes ship as `13.6.0-preview.1`.
- **Deno bullet:** now accurately says `AddDenoApp` is experimental
(`ASPIREDENO001`) and distinct from the Community Toolkit Deno
integration.
- **API vetting:** all 45 API names in the article are verified against
microsoft/aspire `release/13.6` @ `f4c27f2d`. `WithRepl` comes from
microsoft/aspire#20419 and exists on Redis, Valkey, PostgreSQL, MySQL,
SQL Server, and MongoDB.

**Validation** was run against this branch plus the #1787 13.6.0 API
data:
- `twoslash-blocks` passes. A negative control (`withReplz`,
`addSpringBootAppz`) fails with TS2551 as expected.
- 59 API-reference and SEO tests pass.
- All internal links and anchors in the article resolve.

> [!IMPORTANT]
> Merge #1787 first. The new Twoslash blocks need its regenerated 13.6.0
types (`withRepl`, Java, Rust).

---------

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com>
Copilot-Session: 829e510d-2b06-4301-9759-3bd760c45e5c
David Pine (IEvangelist) added a commit that referenced this pull request Sep 29, 2026
## Summary

<!-- Describe what this pull request changes and why. -->

Onboards the first-party Java (`Aspire.Hosting.Java`) and Rust
(`Aspire.Hosting.Rust`) hosting integrations that ship in Aspire 13.6.
The Community Toolkit–based articles are replaced by the official
three-article integration format that other official integrations use:

| Integration | Get started | Set up in the AppHost | Connect |
| --- | --- | --- | --- |
| Java | `java-get-started` (rewritten) | `java-host` (rewritten) |
`java-connect` (new) |
| Rust | `rust-get-started` (rewritten) | `rust-host` (rewritten) |
`rust-connect` (new) |

- **Get started:** why to use the integration, prerequisites, an
architecture diagram, and steps that lead to the other two articles.
- **Set up … apps in the AppHost:**
  - Installation.
- Java: Spring Boot, Quarkus, and Java apps (a Maven or Gradle task, or
a prebuilt JAR), builds, JVM options, the OpenTelemetry Java agent, and
Java containers.
- Rust: Cargo and program arguments, binary selection, and environment
variables.
- Certificate trust, debugging, and publishing, including generated
Dockerfiles.
- A concise **Migrate from the Community Toolkit** section. Rust keeps
the Toolkit-only Bacon note.
- **Connect to … apps:**
  - The connection properties that consumers receive.
  - Connecting from the AppHost and from apps in other languages.
- How the Java or Rust app reads what Aspire injects: its port,
references, connection strings, OTLP telemetry settings, and
development-certificate trust.
- Every API mention uses the new `<ApiReference />` component. Every
TypeScript AppHost sample is `twoslash`-checked, and the TypeScript tab
comes first.
- Adds **Connect to Java apps** and **Connect to Rust apps** to the
integrations sidebar.
- Updates the Java pivot of the AppHost overview
(`get-started/app-host`) to use `Aspire.Hosting.Java` and
`AddSpringBootApp`. The `ja` copy is updated too, because it shares the
`SimpleAppHostCode` sample and its highlight ranges moved.
- A separate commit changes "App Host" to "AppHost" in the EF Core
architecture diagram.

Facts were verified against the microsoft/aspire `release/13.6` sources,
READMEs, and playgrounds. The migration mappings were verified against
the Community Toolkit v13.5.0 APIs.

Notes for reviewers:

- The 📦 `Aspire.Hosting.Java` and `Aspire.Hosting.Rust` NuGet links
resolve once 13.6 ships.
- This branch is rebased on #1787, which regenerated the API data from
the 13.6.0 staging build. The `twoslash` and `ApiReference` tests pass
against the regenerated data.

## Third-party links and affiliations

<!--
List any third-party links added or changed by this pull request and
disclose any
material affiliation with the linked organizations, such as employment,
sponsorship, or ownership. Write "None" if this pull request doesn't add
or
change third-party links.
-->

This PR adds links to project documentation:

- **Java:** dev.java, spring.io, docs.spring.io, quarkus.io,
maven.apache.org, gradle.org, and docs.gradle.org.
- **Rust:** rust-lang.org, doc.rust-lang.org, docs.rs (`axum`,
`opentelemetry-otlp`, `reqwest`, and `sqlx`), and opentelemetry.io.
- **Microsoft:** nuget.org (`CommunityToolkit.Aspire.Hosting.Rust`) and
the Rust playground in github.com/microsoft/aspire. The author is a
Microsoft employee.

There is no material affiliation with the other linked organizations.

## Validation

<!-- List the checks you ran or explain why validation isn't needed. -->

- `pnpm test:unit` (after rebasing on #1787): 977 passed and 1 skipped.
This includes the `twoslash-blocks`, `api-reference`, SEO-length,
redirect, and Dev Hub catalog tests.
- `pnpm build:skip-search`, the production build without the Pagefind
index, completed before the rebase. `starlight-links-validator`
reported: "All internal links are valid."
- ESLint on the changed TypeScript files, the forbidden-words rules on
all added lines, and `git diff --check`.
- Every internal link and anchor resolves: 126 outbound links from the
changed pages and 51 inbound links to the Java and Rust pages. External
URLs were checked too.
- The Rust samples compile with `cargo check`, using
`opentelemetry-otlp` 0.33.
- All six pages were checked visually on the dev server, including the
diagrams, `ApiReference` labels, and tab sync.
- Two independent accuracy reviews against the 13.6 sources. All of
their findings were applied.

---------

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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.

2 participants