Skip to content

Update deployment docs to pipeline-step APIs and remove legacy callback annotation references#1158

Open
IEvangelist with Copilot wants to merge 5 commits into
mainfrom
copilot/update-pipeline-documentation
Open

Update deployment docs to pipeline-step APIs and remove legacy callback annotation references#1158
IEvangelist with Copilot wants to merge 5 commits into
mainfrom
copilot/update-pipeline-documentation

Conversation

Copilot AI commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

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 AI and others added 4 commits June 2, 2026 02:46
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
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 AI requested a review from IEvangelist June 2, 2026 02:51
@IEvangelist 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 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.

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.
Comment on lines 185 to 186
// Do some work here
await Task.Delay(3000);
- `CompletionState` - Enumeration for tracking completion status
- `PublishingContext` - Context for publishing operations
- `PublishingCallbackAnnotation` - Annotation for publishing callbacks
- Legacy publish callback annotation types
- `ClearCache` property in `PublishingOptions`
- `Step` property in `PublishingOptions`
- `DeployingCallbackAnnotation` - Annotation for deploying callbacks
- Legacy deploy callback annotation types
#### `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.
Comment on lines +125 to +126
- **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
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.

Update Pipeline Documentation to remove DeployingCallbackAnnotation and PublishingCallbackAnnotation

3 participants