Document pipeline finalization boundaries - #1587
Draft
Adam Ratzman (adamint) wants to merge 1 commit into
Draft
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 20cc6074-b13b-498c-b22d-112e5b0daeb7
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the deployment pipelines documentation to describe the final publish/deploy aggregates as command-completion points and introduces explicit finalization barriers (PublishFinalize / DeployFinalize) for ordering “normal work” vs. post-finalize hooks.
Changes:
- Reframes
WellKnownPipelineSteps.Publish/Deployas the final command-completion aggregates and corrects prerequisite step names (DeployPrereq,PublishPrereq). - Documents new finalization barriers (
PublishFinalize,DeployFinalize) including a Mermaid diagram and guidance for attaching work vs. post-finalize hooks. - Updates C# and TypeScript examples to use the finalization pattern where appropriate.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/content/docs/deployment/pipelines.mdx | Documents publish/deploy finalization barriers and updates step names/examples to match the finalized pipeline model. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
14 tasks
Contributor
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
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.
Runtime API dependency: microsoft/aspire#19720
Summary
Document the final
publishanddeploycommand aggregates and their finalization barriers.Show ordinary work attaching to
PublishFinalizeorDeployFinalize, and post-finalize hooks depending on the barrier while remaining required by the final aggregate.Preserve legacy direct aggregate attachments as a compatible parallel branch and correct the pipeline examples and prerequisite names.\n\n## Third-party links and affiliations\n\nNone.\n\n## Validation
pnpm --dir ./src/frontend exec prettier --check src/content/docs/deployment/pipelines.mdx— passed.pnpm --dir ./src/frontend lint— passed.pnpm --dir ./src/frontend build:skip-search— passed; 14,707 pages built and all internal links validated.Rendered
/deployment/pipelines/locally — finalization heading and graph labels present, Mermaid rendered to SVG, updated examples present, and zero browser console errors or warnings.git diff --check— passed.