Update deployment docs to pipeline-step APIs and remove legacy callback annotation references by Copilot · Pull Request #1158 · microsoft/aspire.dev

Copilot · 2026-06-02T02:39:01Z

The custom deployment pipeline guidance was outdated and still referenced DeployingCallbackAnnotation / PublishingCallbackAnnotation, which no longer exist. This updates the docs to the current pipeline-step model and removes those legacy references across docs content.

Custom deployment tutorial migrated to current API
- Reworked /deployment/custom-deployments/ to use WithPipelineStepFactory + PipelineStepContext instead of callback annotations.
- Updated examples to show publish/deploy step registration using requiredBy / dependsOn with WellKnownPipelineSteps.
- Kept the tutorial flow intact while swapping in modern code paths and terminology.
Cross-links to current extensibility surfaces
- Added direct links to /deployment/pipelines/ and /extensibility/custom-resources/ from the updated tutorial to anchor readers on the canonical pipeline-step and custom-resource docs.
Legacy type names removed from docs corpus
- Eliminated remaining occurrences of DeployingCallbackAnnotation and PublishingCallbackAnnotation under src/frontend/src/content/docs/.
- Updated adjacent migration/diagnostics/what’s-new wording so references remain accurate without pointing to removed APIs.

return builder.AddResource(resource)
    .WithPipelineStepFactory(
        stepName: $"{name}-build-images",
        callback: PublishAsync,
        requiredBy: [WellKnownPipelineSteps.Publish])
    .WithPipelineStepFactory(
        stepName: $"{name}-deploy",
        callback: DeployAsync,
        dependsOn: [$"{name}-build-images"],
        requiredBy: [WellKnownPipelineSteps.Deploy]);

Copilot

Pull request overview

This PR updates Aspire deployment documentation to remove references to legacy callback annotation APIs and align guidance/examples with the newer pipeline-step model (for publish/deploy extensibility and progress reporting).

Changes:

Migrates the custom deployments tutorial to pipeline-step registration (WithPipelineStepFactory, PipelineStepContext, step dependencies).
Removes remaining DeployingCallbackAnnotation / PublishingCallbackAnnotation mentions across “what’s new”, pipelines, and diagnostics docs (including JA translations).
Updates surrounding wording/cross-links to point readers to pipeline and custom-resource extensibility docs.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
src/frontend/src/content/docs/whats-new/aspire-9-4.mdx	Reworks the `aspire deploy` extensibility example toward pipeline steps and updates narrative around deploy workflow reporting.
src/frontend/src/content/docs/whats-new/aspire-9-3.mdx	Removes explicit legacy type name from publisher model description.
src/frontend/src/content/docs/whats-new/aspire-13.mdx	Rephrases removed-API list entries to avoid legacy callback annotation type names.
src/frontend/src/content/docs/ja/whats-new/aspire-13.mdx	JP equivalent of Aspire 13 removed-API list wording updates.
src/frontend/src/content/docs/deployment/pipelines.mdx	Updates “Removed APIs” list to avoid legacy callback annotation type names.
src/frontend/src/content/docs/ja/deployment/pipelines.mdx	JP equivalent “Removed APIs” list wording updates.
src/frontend/src/content/docs/diagnostics/aspirepipelines001.mdx	Removes explicit legacy type name from affected-APIs list.
src/frontend/src/content/docs/diagnostics/aspirepipelines002.mdx	Removes explicit legacy type name from affected-APIs list.
src/frontend/src/content/docs/deployment/custom-deployments.mdx	Migrates tutorial from callback annotations to pipeline-step factories, including updated progress reporting examples and links.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

-
-            var step = await reporter.CreateStepAsync("Seeding data", ct);
-            var task = await step.CreateTaskAsync($"Loading seed data from {seedDataPath}", ct);
+            // ReportingStep represents the current pipeline step context.


 #### `aspire deploy`

-The `aspire deploy` command supports extensible deployment workflows through the new [`DeployingCallbackAnnotation`](https://aspire.dev/fundamentals/annotations-overview/), enabling custom pre/post-deploy logic and richer integration with external systems during deployment operations.
+The `aspire deploy` command introduced extensible deployment workflows through deployment callback annotations, enabling custom pre/post-deploy logic and richer integration with external systems during deployment operations.


+- **Workflow activity reporting** via the `Aspire.Hosting.Publishing.IPublishingActivityReporter` to support progress notifications and prompting in commands
+- **Integration with publish** - `aspire deploy` can run publish-related callbacks to support deploying artifacts emitted by publish steps, if applicable


Adam Ratzman (adamint) · 2026-08-07T03:39:54Z

There is one more blocking issue that does not map cleanly to a changed line: custom-deployments.mdx still references removed PublishingContext.ActivityReporter and the old CompletePublishAsync(message, state, isDeploy, ct) shape. The current pipeline API uses PipelineStepContext.ReportingStep, and completion is runner-invoked with PublishCompletionOptions. Could we update that surrounding section too so the page is internally consistent?

aspire-repo-bot · 2026-08-07T16:55:24Z

Frontend HTML artifact ready

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

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

aspire-repo-bot

Automated wording suggestions from the forbidden-words check. Apply the suggestions to resolve them.

aspire-repo-bot · 2026-08-07T17:29:55Z

+const horizontalWhitespace = String.raw`[ \t]+`;
+
+// A deprecated term only matches when it isn't fused to an adjacent alphanumeric
+// character, so longer tokens like `ASP.NET Aspire` or `.NET AspireX` stay intact


Use "Aspire" instead of ".NET Aspire".

Suggested change

// character, so longer tokens like `ASP.NET Aspire` or `.NET AspireX` stay intact

// character, so longer tokens like `ASPAspire` or `AspireX` stay intact

aspire-repo-bot · 2026-08-07T17:29:55Z

+const termEnd = String.raw`(?![A-Za-z0-9])`;
+
+// Markdown emphasis/link openers can sit between an article and a term in raw
+// README content (e.g. `a **.NET Aspire**`, `a [.NET Aspire](url)`, or


Use "Aspire" instead of ".NET Aspire".

Suggested change

// README content (e.g. `a **.NET Aspire**`, `a [.NET Aspire](url)`, or

// README content (e.g. `a **Aspire**`, `a [Aspire](url)`, or

aspire-repo-bot · 2026-08-07T17:29:55Z

+
+// Markdown emphasis/link openers can sit between an article and a term in raw
+// README content (e.g. `a **.NET Aspire**`, `a [.NET Aspire](url)`, or
+// `a _.NET Aspire_`), so the article corrector consumes them to stay grammatical


Use "Aspire" instead of ".NET Aspire".

Suggested change

// `a _.NET Aspire_`), so the article corrector consumes them to stay grammatical

// `a _Aspire_`), so the article corrector consumes them to stay grammatical

aspire-repo-bot · 2026-08-07T17:29:55Z

+const markdownOpeners = String.raw`[*\[_]*`;
+
+// Fenced code blocks and inline code spans are copied through verbatim so sample
+// commands like `dotnet aspire run` are never rewritten into an unrunnable


Use "Aspire" instead of "dotnet aspire".

Suggested change

// commands like `dotnet aspire run` are never rewritten into an unrunnable

// commands like `Aspire run` are never rewritten into an unrunnable

aspire-repo-bot · 2026-08-07T17:29:55Z

+   * Case-insensitive regex source matching the deprecated term core, without
+   * boundaries. Use `${horizontalWhitespace}` for internal spaces; alphanumeric
+   * boundaries are applied automatically so a rule can never corrupt a longer
+   * token like `ASP.NET Aspire` or `.NET AspireX`.


Use "Aspire" instead of ".NET Aspire".

Suggested change

* token like `ASP.NET Aspire` or `.NET AspireX`.

* token like `ASPAspire` or `AspireX`.

aspire-repo-bot · 2026-08-07T17:29:55Z

+  /**
+   * Indefinite article the replacement should take. Set this only when the
+   * replacement's leading sound differs from the term's, so a preceding `a`/`an`
+   * is corrected (e.g. `a .NET Aspire` -> `an Aspire`).


Use "Aspire" instead of ".NET Aspire".

Suggested change

* is corrected (e.g. `a .NET Aspire` -> `an Aspire`).

* is corrected (e.g. `a Aspire` -> `an Aspire`).

aspire-repo-bot · 2026-08-07T17:29:55Z

-seoTitle: Bun integration for Aspire AppHost (Community Toolkit)
-description: Learn how to use the Aspire Community Toolkit Bun hosting integration to orchestrate Bun applications alongside other resources in the Aspire app host.
+seoTitle: Bun integration for Aspire AppHost
+description: Learn how to use the Aspire.Hosting.JavaScript Bun hosting APIs to orchestrate Bun applications alongside other resources in the Aspire app host.


Use "AppHost" instead of "app host".

Suggested change

description: Learn how to use the Aspire.Hosting.JavaScript Bun hosting APIs to orchestrate Bun applications alongside other resources in the Aspire app host.

description: Learn how to use the Aspire.Hosting.JavaScript Bun hosting APIs to orchestrate Bun applications alongside other resources in the Aspire AppHost.

aspire-repo-bot · 2026-08-07T17:29:55Z

+    ['uppercase article', `A ${legacyDotnetAspireName} sample`, 'An Aspire sample'],
+    ['lowercase article', `Build a ${legacyDotnetAspireName} sample`, 'Build an Aspire sample'],
+    ['no article', `Deploy the ${legacyDotnetAspireName} app`, 'Deploy the Aspire app'],
+  ])('normalizes the "dotnet aspire" spelling (%s)', (_scenario, input, expected) => {


Use "Aspire" instead of "dotnet aspire".

Suggested change

])('normalizes the "dotnet aspire" spelling (%s)', (_scenario, input, expected) => {

])('normalizes the "Aspire" spelling (%s)', (_scenario, input, expected) => {

aspire-repo-bot · 2026-08-07T17:29:55Z

+  test('normalizes prose while preserving adjacent code', () => {
+    const input = `Build a ${legacyAspireName} app, then run \`${legacyDotnetAspireName} run\`.`;
+    expect(normalizeAspireTerminology(input)).toBe(
+      'Build an Aspire app, then run `dotnet aspire run`.'


Use "Aspire" instead of "dotnet aspire".

Suggested change

'Build an Aspire app, then run `dotnet aspire run`.'

'Build an Aspire app, then run `Aspire run`.'

Refresh custom deployment examples for pipeline steps and clarify legacy callback references in deployment, diagnostics, and release notes. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 5b0c81a3-d822-462e-8cf5-8eb6debfe968

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI assigned Copilot and David Pine (IEvangelist) Jun 2, 2026

Copilot started work on behalf of David Pine (IEvangelist) June 2, 2026 02:39 View session

Copilot AI linked an issue Jun 2, 2026 that may be closed by this pull request

Update Pipeline Documentation to remove DeployingCallbackAnnotation and PublishingCallbackAnnotation #832

Open

Copilot AI changed the title ~~[WIP] Update pipeline documentation to remove outdated annotations~~ Update deployment docs to pipeline-step APIs and remove legacy callback annotation references Jun 2, 2026

Copilot finished work on behalf of David Pine (IEvangelist) June 2, 2026 02:51

Copilot AI requested a review from David Pine (IEvangelist) June 2, 2026 02:51

David Pine (IEvangelist) marked this pull request as ready for review June 30, 2026 08:38

Copilot AI review requested due to automatic review settings June 30, 2026 08:38

Copilot started reviewing on behalf of David Pine (IEvangelist) June 30, 2026 08:39 View session

Copilot AI reviewed Jun 30, 2026

View reviewed changes

Adam Ratzman (adamint) reviewed Aug 7, 2026

View reviewed changes

Comment thread src/frontend/src/content/docs/whats-new/aspire-9-4.mdx Outdated

Adam Ratzman (adamint) reviewed Aug 7, 2026

View reviewed changes

Comment thread src/frontend/src/content/docs/whats-new/aspire-9-3.mdx Outdated

Adam Ratzman (adamint) reviewed Aug 7, 2026

View reviewed changes

Comment thread src/frontend/src/content/docs/deployment/custom-deployments.mdx

David Pine (IEvangelist) requested review from James Newton-King (JamesNK), Aaron Powell (aaronpowell), David Fowler (davidfowl), Eric Erhardt (eerhardt), Maddy Montaquila (maddymontaquila) and Mitch Denny (mitchdenny) as code owners August 7, 2026 16:40

aspire-repo-bot Bot reviewed Aug 7, 2026

View reviewed changes

David Pine (IEvangelist) added the ci:skip-forbidden-words Allows maintainers to bypass false positives in the forbidden-word check. label Aug 7, 2026

David Pine (IEvangelist) removed the ci:skip-forbidden-words Allows maintainers to bypass false positives in the forbidden-word check. label Aug 7, 2026

David Pine (IEvangelist) force-pushed the copilot/update-pipeline-documentation branch from 2223db7 to 1597377 Compare August 7, 2026 20:09

Apply suggestions from code review

467d4f8

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

		- Workflow activity reporting via the `Aspire.Hosting.Publishing.IPublishingActivityReporter` to support progress notifications and prompting in commands
		- Integration with publish - `aspire deploy` can run publish-related callbacks to support deploying artifacts emitted by publish steps, if applicable

	// character, so longer tokens like `ASP.NET Aspire` or `.NET AspireX` stay intact
	// character, so longer tokens like `ASPAspire` or `AspireX` stay intact

	// README content (e.g. `a .NET Aspire`, `a [.NET Aspire](url)`, or
	// README content (e.g. `a Aspire`, `a [Aspire](url)`, or

	// `a _.NET Aspire_`), so the article corrector consumes them to stay grammatical
	// `a _Aspire_`), so the article corrector consumes them to stay grammatical

	// commands like `dotnet aspire run` are never rewritten into an unrunnable
	// commands like `Aspire run` are never rewritten into an unrunnable

	* token like `ASP.NET Aspire` or `.NET AspireX`.
	* token like `ASPAspire` or `AspireX`.

	* is corrected (e.g. `a .NET Aspire` -> `an Aspire`).
	* is corrected (e.g. `a Aspire` -> `an Aspire`).

	description: Learn how to use the Aspire.Hosting.JavaScript Bun hosting APIs to orchestrate Bun applications alongside other resources in the Aspire app host.
	description: Learn how to use the Aspire.Hosting.JavaScript Bun hosting APIs to orchestrate Bun applications alongside other resources in the Aspire AppHost.

	])('normalizes the "dotnet aspire" spelling (%s)', (_scenario, input, expected) => {
	])('normalizes the "Aspire" spelling (%s)', (_scenario, input, expected) => {

	'Build an Aspire app, then run `dotnet aspire run`.'
	'Build an Aspire app, then run `Aspire run`.'

Uh oh!

Conversation

Copilot AI commented Jun 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Adam Ratzman (adamint) commented Aug 7, 2026

Uh oh!

aspire-repo-bot Bot commented Aug 7, 2026

Frontend HTML artifact ready

Uh oh!

aspire-repo-bot Bot left a comment

Choose a reason for hiding this comment

Uh oh!

aspire-repo-bot Bot Aug 7, 2026

Choose a reason for hiding this comment

Uh oh!

aspire-repo-bot Bot Aug 7, 2026

Choose a reason for hiding this comment

Uh oh!

aspire-repo-bot Bot Aug 7, 2026

Choose a reason for hiding this comment

Uh oh!

aspire-repo-bot Bot Aug 7, 2026

Choose a reason for hiding this comment

Uh oh!

aspire-repo-bot Bot Aug 7, 2026

Choose a reason for hiding this comment

Uh oh!

aspire-repo-bot Bot Aug 7, 2026

Choose a reason for hiding this comment

Uh oh!

aspire-repo-bot Bot Aug 7, 2026

Choose a reason for hiding this comment

Uh oh!

aspire-repo-bot Bot Aug 7, 2026

Choose a reason for hiding this comment

Uh oh!

aspire-repo-bot Bot Aug 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Jun 2, 2026 •

edited

Loading