Skip to content

Unpreview Aspire CLI deployment commands#17174

Merged
davidfowl merged 1 commit into
mainfrom
davidfowl/cli-preview-descriptions
May 17, 2026
Merged

Unpreview Aspire CLI deployment commands#17174
davidfowl merged 1 commit into
mainfrom
davidfowl/cli-preview-descriptions

Conversation

@davidfowl
Copy link
Copy Markdown
Contributor

Description

The CLI deployment/update commands are no longer preview, so the command help and CLI README should not label them that way. This updates the localized command description resources for aspire deploy, aspire destroy, aspire do, aspire publish, and aspire update, and refreshes the related XLIFF source strings.

The CLI README now also lists destroy in the Deployment command table.

User-facing usage

Root help now shows these commands without the preview moniker:

App commands:
  update                           Update integrations in the Aspire project

Deployment:
  deploy                           Deploy an AppHost to its deployment targets
  destroy                          Destroy a previously deployed AppHost environment
  do [<step>]                      Execute a specific pipeline step and its dependencies
  publish                          Generate deployment artifacts for an AppHost

The dashboard command remains preview-labeled:

Monitoring:
  dashboard                        Manage the Aspire dashboard (Preview)

Validation:

  • dotnet build /t:UpdateXlf src/Aspire.Cli/Aspire.Cli.csproj
  • dotnet build src/Aspire.Cli/Aspire.Cli.csproj /p:SkipNativeBuild=true
  • dotnet artifacts/bin/Aspire.Cli/Debug/net10.0/aspire.dll --help

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 <223556219+Copilot@users.noreply.github.com>
@davidfowl davidfowl requested a review from mitchdenny as a code owner May 16, 2026 18:29
Copilot AI review requested due to automatic review settings May 16, 2026 18:29
@davidfowl davidfowl requested a review from JamesNK as a code owner May 16, 2026 18:29
@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 -- 17174

Or

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

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Removes the "(Preview)" label from the deploy, destroy, do, publish, and update CLI command descriptions across resx/Designer/xlf files, and adds destroy to the README Deployment commands table.

Changes:

  • Drop "(Preview)" from English source strings in 5 resx files and their Designer.cs summaries.
  • Update all 13 localized xlf files for each command (source strings; cs.xlf targets also stripped of "(Preview)"; Destroy targets in "new" state mirror the English).
  • README: remove "(Preview)" suffixes and add destroy row to Deployment table.
Show a summary per file
File Description
src/Aspire.Cli/Resources/{Deploy,Destroy,Do,Publish,Update}CommandStrings.resx Source strings unpreviewed
src/Aspire.Cli/Resources/{Deploy,Destroy,Do,Publish,Update}CommandStrings.Designer.cs XML doc summaries updated
src/Aspire.Cli/Resources/xlf/*.xlf (13 locales × 5 commands) Source updated; cs.xlf and Destroy *.xlf targets adjusted
src/Aspire.Cli/README.md Removed "(Preview)" tags; added destroy row

Note: Non-cs locale xlf targets still contain the translated "(Preview/预览/プレビュー/etc.)" suffix while their <source> no longer does, which is the expected behavior for UpdateXlf — those translations will be refreshed by the localization process (state already needs-review-translation). No action required.

Copilot's findings

Files not reviewed (5)
  • src/Aspire.Cli/Resources/DeployCommandStrings.Designer.cs: Language not supported
  • src/Aspire.Cli/Resources/DestroyCommandStrings.Designer.cs: Language not supported
  • src/Aspire.Cli/Resources/DoCommandStrings.Designer.cs: Language not supported
  • src/Aspire.Cli/Resources/PublishCommandStrings.Designer.cs: Language not supported
  • src/Aspire.Cli/Resources/UpdateCommandStrings.Designer.cs: Language not supported
  • Files reviewed: 71/76 changed files
  • Comments generated: 0

@github-actions
Copy link
Copy Markdown
Contributor

CLI E2E Tests unknown — 85 passed, 0 failed, 1 unknown (commit 8312e67)

View all recordings
Status Test Recording
AddPackageInteractiveWhileAppHostRunningDetached ▶️ View recording
AddPackageWhileAppHostRunningDetached ▶️ View recording
AgentCommands_AllHelpOutputs_AreCorrect ▶️ View recording
AgentInitCommand_DefaultSelection_InstallsSkillOnly ▶️ View recording
AgentInitCommand_MigratesDeprecatedConfig ▶️ View recording
AspireAddPackageVersionToDirectoryPackagesProps ▶️ View recording
AspireInitSingleFileAppHostRunsViaDotnetRunAppHost ▶️ View recording
AspireInitWithExistingAppHostDirRecreatesMissingNuGetConfigAndPreservesFiles ▶️ View recording
AspireInitWithSolutionFileGeneratesAppHostThatBuildsAgainstChannelHive ▶️ View recording
AspireUpdateRemovesAppHostPackageVersionFromDirectoryPackagesProps ▶️ View recording
AspireUpdateRemovesOrphanAppHostPackageVersionWhenSdkAlreadyCurrent ▶️ View recording
Banner_DisplayedOnFirstRun ▶️ View recording
Banner_DisplayedWithExplicitFlag ▶️ View recording
Banner_NotDisplayedWithNoLogoFlag ▶️ View recording
CertificatesClean_RemovesCertificates ▶️ View recording
CertificatesTrust_WithNoCert_CreatesAndTrustsCertificate ▶️ View recording
CertificatesTrust_WithUntrustedCert_TrustsCertificate ▶️ View recording
ConfigSetGet_CreatesNestedJsonFormat ▶️ View recording
CreateAndRunAspireStarterProject ▶️ View recording
CreateAndRunAspireStarterProjectWithBundle ▶️ View recording
CreateAndRunEmptyAppHostProject ▶️ View recording
CreateAndRunJavaEmptyAppHostProject ▶️ View recording
CreateAndRunJsReactProject ▶️ View recording
CreateAndRunPythonReactProject ▶️ View recording
CreateAndRunTypeScriptEmptyAppHostProject ▶️ View recording
CreateAndRunTypeScriptStarterProject ▶️ View recording
CreateJavaAppHostWithViteApp ▶️ View recording
CreateTypeScriptAppHostWithViteApp_UsesConfiguredToolchain ▶️ View recording
DashboardRunWithOtelTracesReturnsNoTraces ▶️ View recording
DeployK8sBasicApiService ▶️ View recording
DeployK8sWithExternalHelmChart ▶️ View recording
DeployK8sWithGarnet ▶️ View recording
DeployK8sWithMongoDB ▶️ View recording
DeployK8sWithMySql ▶️ View recording
DeployK8sWithPostgres ▶️ View recording
DeployK8sWithRabbitMQ ▶️ View recording
DeployK8sWithRedis ▶️ View recording
DeployK8sWithSqlServer ▶️ View recording
DeployK8sWithValkey ▶️ View recording
DeployTypeScriptAppToKubernetes ▶️ View recording
DescribeCommandResolvesReplicaNames ▶️ View recording
DescribeCommandShowsRunningResources ▶️ View recording
DetachFormatJsonProducesValidJson ▶️ View recording
DetachFormatJsonProducesValidJsonWhenRestartingExistingInstance ▶️ View recording
DoListStepsShowsPipelineSteps ▶️ View recording
DocsCommand_RendersInteractiveMarkdownFromLocalSource ▶️ View recording
DoctorCommand_DetectsDeprecatedAgentConfig ▶️ View recording
DoctorCommand_TypeScriptAppHostReportsMissingConfiguredToolchain ▶️ View recording
DoctorCommand_WithSslCertDir_ShowsTrusted ▶️ View recording
DoctorCommand_WithoutSslCertDir_ShowsPartiallyTrusted ▶️ View recording
GlobalMigration_HandlesCommentsAndTrailingCommas ▶️ View recording
GlobalMigration_HandlesMalformedLegacyJson ▶️ View recording
GlobalMigration_PreservesAllValueTypes ▶️ View recording
GlobalMigration_SkipsWhenNewConfigExists ▶️ View recording
GlobalSettings_MigratedFromLegacyFormat ▶️ View recording
InitTypeScriptAppHost_AugmentsExistingViteRepoAtRoot ▶️ View recording
InteractiveCSharpInitCreatesExpectedFiles ▶️ View recording
InvalidAppHostPathWithComments_IsHealedOnRun ▶️ View recording
LatestCliCanStartStableChannelAppHost ▶️ View recording
LatestCliCanStartStableChannelTypeScriptAppHost ▶️ View recording
LegacySettingsMigration_AdjustsRelativeAppHostPath ▶️ View recording
LogLevelTrace_ProducesTraceEntriesInCliLogFile ▶️ View recording
LogsCommandShowsResourceLogs ▶️ View recording
OtelLogsReturnsStructuredLogsFromStarterApp ▶️ View recording
OtelLogsReturnsStructuredLogsFromStarterAppIsolated ▶️ View recording
PsCommandListsRunningAppHost ▶️ View recording
PsFormatJsonOutputsOnlyJsonToStdout ▶️ View recording
PublishWithConfigureEnvFileUpdatesEnvOutput ▶️ View recording
PublishWithDockerComposeServiceCallbackSucceeds ▶️ View recording
PublishWithoutOutputPathUsesAppHostDirectoryDefault ▶️ View recording
ResourceCommand_FailsWhenInteractionServiceIsRequired ▶️ View recording
ResourceCommand_SetAndDeleteParameterUpdatesDescribeOutput ▶️ View recording
RestoreGeneratesSdkFiles ▶️ View recording
RestoreGeneratesSdkFiles_WithConfiguredToolchain ▶️ View recording
RestoreRefreshesGeneratedSdkAfterAddingIntegration ▶️ View recording
RestoreSupportsConfigOnlyHelperPackageAndCrossPackageTypes ▶️ View recording
RunFromParentDirectory_UsesExistingConfigNearAppHost ▶️ View recording
SecretCrudOnDotNetAppHost ▶️ View recording
SecretCrudOnTypeScriptAppHost ▶️ View recording
StagingChannel_ConfigureAndVerifySettings_ThenSwitchChannels ▶️ View recording
StartAndWaitForTypeScriptSqlServerAppHostWithNativeAssets ▶️ View recording
StopAllAppHostsFromAppHostDirectory ▶️ View recording
StopNonInteractiveSingleAppHost ▶️ View recording
StopWithNoRunningAppHostExitsSuccessfully ▶️ View recording
UnAwaitedChainsCompileWithAutoResolvePromises ▶️ View recording
UpdateProjectChannelToStable_TypeScript_PicksUpStablePackages ▶️ View recording

📹 Recordings uploaded automatically from CI run #25969562773

@davidfowl davidfowl merged commit 2dfbcdd into main May 17, 2026
590 of 593 checks passed
@github-actions github-actions Bot added this to the 13.4 milestone May 17, 2026
nellshamrell pushed a commit to nellshamrell/aspire that referenced this pull request May 18, 2026
Co-authored-by: Copilot <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.

3 participants