Update deployment docs to pipeline-step APIs and remove legacy callback annotation references#1158
Open
IEvangelist with Copilot wants to merge 5 commits into
Open
Update deployment docs to pipeline-step APIs and remove legacy callback annotation references#1158IEvangelist with Copilot wants to merge 5 commits into
IEvangelist with Copilot wants to merge 5 commits into
Conversation
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
Contributor
There was a problem hiding this comment.
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/PublishingCallbackAnnotationmentions 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 |
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.
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
/deployment/custom-deployments/to useWithPipelineStepFactory+PipelineStepContextinstead of callback annotations.requiredBy/dependsOnwithWellKnownPipelineSteps.Cross-links to current extensibility surfaces
/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
DeployingCallbackAnnotationandPublishingCallbackAnnotationundersrc/frontend/src/content/docs/.