Skip to content

Commit dbdc9e8

Browse files
CopilotIEvangelist
andcommitted
Fix inaccurate diagnostics output example and remove unverified WithPipelineConfiguration API usage
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
1 parent a125016 commit dbdc9e8

File tree

1 file changed

+9
-26
lines changed

1 file changed

+9
-26
lines changed

src/frontend/src/content/docs/get-started/pipelines.mdx

Lines changed: 9 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -419,18 +419,12 @@ This command displays:
419419
- Step dependencies and target resources
420420
- Configuration issues like orphaned steps or circular dependencies
421421

422-
**Example diagnostics output:**
422+
The output includes several sections:
423423

424-
```
425-
Pipeline Steps:
426-
✓ build-apiservice (parallel)
427-
✓ build-frontend (parallel)
428-
✓ provision-database (parallel)
429-
→ push-apiservice (depends on: build-apiservice, provision-registry)
430-
→ push-frontend (depends on: build-frontend, provision-registry)
431-
→ deploy-apiservice (depends on: push-apiservice, provision-database)
432-
→ deploy-frontend (depends on: push-frontend, deploy-apiservice)
433-
```
424+
- **Execution order**: A numbered list showing the order in which steps would execute
425+
- **Detailed step analysis**: Each step's dependencies, associated resources, tags, and descriptions (✓ = dependency exists, ? = dependency missing)
426+
- **Potential issues**: Identifies problems like orphaned steps or circular dependencies
427+
- **Execution simulation**: "What if" analysis showing what steps would run for each possible target step, with concurrency indicators for steps that can run in parallel
434428

435429
## Custom pipeline steps
436430

@@ -516,22 +510,11 @@ requiredBy: ["deploy-apiservice"]);
516510

517511
### Pipeline configuration
518512

519-
Resources can also customize how they participate in the pipeline using `WithPipelineConfiguration`:
513+
Resources can also customize how they participate in the pipeline using `WithPipelineConfiguration`, which provides control over step ordering and resource-specific pipeline behavior.
520514

521-
```csharp title="C# — Custom pipeline configuration"
522-
var api = builder.AddProject<Projects.Api>("api")
523-
.WithPipelineConfiguration(config =>
524-
{
525-
// Skip this resource during certain pipeline steps
526-
config.SkipStep(WellKnownPipelineSteps.Push);
527-
528-
// Or add custom behavior
529-
config.OnStepStarting = (step) =>
530-
{
531-
Console.WriteLine($"Starting step: {step.Name}");
532-
};
533-
});
534-
```
515+
<Aside type="note">
516+
The `WithPipelineConfiguration` API is experimental and may change in future releases. Refer to the [aspire do command reference](/reference/cli/commands/aspire-do/) for the latest details on pipeline configuration.
517+
</Aside>
535518

536519
## Common use cases
537520

0 commit comments

Comments
 (0)