Skip to content

Rename CompletePublishAsync to CompleteAsync in IPublishingActivityReporter#10689

Closed
Copilot wants to merge 2 commits intomainfrom
copilot/fix-bd3e1a8a-b229-429e-8de5-d2ea75c37397
Closed

Rename CompletePublishAsync to CompleteAsync in IPublishingActivityReporter#10689
Copilot wants to merge 2 commits intomainfrom
copilot/fix-bd3e1a8a-b229-429e-8de5-d2ea75c37397

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jul 28, 2025

This PR renames the CompletePublishAsync method to CompleteAsync on the IPublishingActivityReporter interface and its implementation to improve API consistency and naming clarity.

Background

The IPublishingActivityReporter interface had a method named CompletePublishAsync that signals when the entire publishing process has completed. However, this naming was inconsistent with other completion methods in the codebase, such as IPublishingStep.CompleteAsync and PublishingTask.CompleteAsync, which use the simpler CompleteAsync naming pattern.

Changes

  • Interface: Renamed CompletePublishAsync to CompleteAsync in IPublishingActivityReporter
  • Implementation: Updated method implementation in PublishingActivityReporter class
  • Call Sites: Updated 2 method calls in DistributedApplicationRunner.cs
  • Tests: Updated 5 test method names and 10 method calls in PublishingActivityReporterTests.cs

Verification

  • ✅ No naming conflicts with existing CompleteAsync methods (they exist on different types)
  • ✅ All builds compile successfully without errors or warnings
  • ✅ XML documentation preserved and correctly generated
  • ✅ No remaining references to the old method name in source code

The method signature and behavior remain unchanged - this is purely a naming improvement for consistency across the publishing API.

This pull request was created as a result of the following prompt from Copilot chat.

Rename the method CompletePublishAsync to CompleteAsync on the IPublishingActivityReporter and its implementation(s). Update all call sites, documentation comments, and tests accordingly to use the new method name. Ensure consistency across the codebase and verify that the new method name does not create ambiguities or conflicts with existing methods (such as other CompleteAsync overloads).

Steps:

  • Locate the CompletePublishAsync method on IPublishingActivityReporter (and implementation, likely PublishingActivityReporter).
  • Rename CompletePublishAsync to CompleteAsync in the interface and all implementing classes.
  • Update all call sites in the codebase to use the new method name.
  • Update any XML documentation or comments referencing CompletePublishAsync.
  • Update any affected tests.
  • Ensure the build passes and there are no ambiguous overloads or naming conflicts as a result of the rename.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…porter

Co-authored-by: mitchdenny <513398+mitchdenny@users.noreply.github.com>
Copilot AI changed the title [WIP] Rename CompletePublishAsync to CompleteAsync on IPublishingActivityReporter and update all usages Rename CompletePublishAsync to CompleteAsync in IPublishingActivityReporter Jul 28, 2025
Copilot AI requested a review from mitchdenny July 28, 2025 03:13
@mitchdenny
Copy link
Copy Markdown
Member

@captainsafia at one point I felt strongly that we should rename CompletePublishAsync to CompleteAsync but given you've been closer to this lately I'll let you make the call on this. For now I'm closing this very stale PR.

@mitchdenny mitchdenny closed this Sep 3, 2025
@dotnet-policy-service dotnet-policy-service Bot added this to the 9.5 milestone Sep 3, 2025
@captainsafia
Copy link
Copy Markdown
Contributor

@captainsafia at one point I felt strongly that we should rename CompletePublishAsync to CompleteAsync but given you've been closer to this lately I'll let you make the call on this. For now I'm closing this very stale PR.

I agree with you, especially given that we've now made it so that deploy doesn't implicitly run publish. We can resolve this once the API surface for this area has stabilized and we're taking the experiemental attribute off of things.

@github-actions github-actions Bot locked and limited conversation to collaborators Oct 4, 2025
@sebastienros sebastienros deleted the copilot/fix-bd3e1a8a-b229-429e-8de5-d2ea75c37397 branch January 15, 2026 16:25
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants