[release/13.4] Make npm package README TypeScript-only and document standalone dashboard#18221
Draft
adamint wants to merge 2 commits into
Draft
[release/13.4] Make npm package README TypeScript-only and document standalone dashboard#18221adamint wants to merge 2 commits into
adamint wants to merge 2 commits into
Conversation
…oard Port of microsoft#18220 to release/13.4. - Remove the C# AppHost example so the npm README is TypeScript-only. - Refresh the TypeScript example to the current ts-starter template (apphost.mts importing ./.aspire/modules/aspire.mjs), fixing the stale apphost.ts / aspire.js references that no longer match the template. - Add a Postgres + Redis backing-services example with an `aspire add` note for the postgresql and redis integrations. - Add a Standalone dashboard section documenting `aspire dashboard run`. - Update NpmCliPackageTests to assert the TypeScript-only README content. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 18221Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 18221" |
Contributor
There was a problem hiding this comment.
Pull request overview
This is a backport of PR #18220 to release/13.4. It rewrites the Aspire CLI npm package README to be TypeScript-only (removing the C# AppHost example), refreshes the TypeScript example to match the actual ts-starter template (apphost.mts importing .mjs), adds a backing-services example and standalone dashboard documentation, and updates tests to assert the new content.
Changes:
- Replace the dual C#/TypeScript README example with a single TypeScript example matching the
ts-startertemplate, plus a second example showing Postgres/Redis backing services. - Add a "Standalone dashboard" section documenting
aspire dashboard runand its options. - Update
NpmCliPackageTestswith assertions confirming TypeScript-only content and absence of C#/stale references.
Show a summary per file
| File | Description |
|---|---|
| eng/scripts/pack-cli-npm-package.pointer.README.md | Rewrites README to TypeScript-only examples, adds backing-services and standalone dashboard sections |
| tests/Infrastructure.Tests/Pipelines/NpmCliPackageTests.cs | Adds positive and negative assertions for new README content |
Copilot's findings
- Files reviewed: 2/2 changed files
- Comments generated: 1
Comment on lines
+69
to
71
| `addPostgres` and `addRedis` become available once the matching integrations are installed with `aspire add postgresql` and `aspire add redis`. | ||
|
|
||
| This package requires Node.js 20 or later. |
Code review found the install instructions were orphaned under the 'Add backing services' subsection after the C# example removal. Restore the '## Install' heading so install steps render as their own section. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
Contributor
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
Contributor
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Port of #18220 to
release/13.4.Updates the Aspire CLI npm package README (
eng/scripts/pack-cli-npm-package.pointer.README.md) to be TypeScript-only and to document the standalone dashboard.Changes
apphost.tsand./.aspire/modules/aspire.js, but the actual 13.4ts-startertemplate already usesapphost.mtsimporting./.aspire/modules/aspire.mjs. This change brings the README in line with the template (matchingmain).addPostgres/addRedisbecome available afteraspire add postgresqlandaspire add redis.aspire dashboard runcommand and its OTLP endpoints/options.NpmCliPackageTeststo assert the TypeScript-only README content.Verification
AtsCapabilityScanner+AtsTypeScriptCodeGenerator) andtsc --noEmit(strict NodeNext) on the same release line; example 1 is byte-identical to the 13.4ts-startertemplate.aspire dashboard runis provided byDashboardRunCommandon 13.4 with the documented options/defaults.NpmCliPackageTests.PackScriptGeneratesPointerPackageMetadataMapAndReadmepasses locally.Draft until CI is green.