Skip to content

Conversation

@jiripolasek
Copy link
Collaborator

@jiripolasek jiripolasek commented Dec 10, 2025

Summary of the Pull Request

This PR adds PublicApiAnalyzers to Microsoft.CommandPalette.Extensions.Toolkit project to track changes in Command Palette SDK APIs

  • Integrates PublicApiAnalyzers to monitor and track changes made to the public APIs in the Command Palette SDK.
  • Adds a definition for shipped API definition based on stable branch - tag 0.96.1.

PR Checklist

  • Communication: I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected
  • Tests: Added/updated and all pass
  • Localization: All end-user-facing strings can be localized
  • Dev docs: Added/updated
  • New binaries: Added on the required places
  • Documentation updated: If checked, please file a pull request on our docs repo and link it here: #xxx

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

… project to track changes in Command Palette SDK APIs

- Integrates PublicApiAnalyzers to monitor and track changes made to the public APIs in the Command Palette SDK.
- Adds a definition for shipped API definition based on stable branch - tag 0.96.1.
@jiripolasek jiripolasek requested a review from a team as a code owner December 10, 2025 21:13
@jiripolasek jiripolasek added the Product-Command Palette Refers to the Command Palette utility label Dec 10, 2025
@jiripolasek jiripolasek self-assigned this Dec 10, 2025
@jiripolasek jiripolasek marked this pull request as draft December 10, 2025 21:17
@github-actions

This comment has been minimized.

@jiripolasek
Copy link
Collaborator Author

@zadjii-msft
Do you think it could be useful? It might add a bit of overhead, but it should make tracking SDK changes much easier and provide extra opportunities to catch anything unusual (in case – squirrel forbid – something slips through PRs).

The analyzer forces developers to record changes to public APIs in a text file. During release, there’s an extra step where someone needs to move the changes from unshipped to shipped.

<packageSources>
<clear />
<add key="PowerToysPublicDependencies" value="https://pkgs.dev.azure.com/shine-oss/PowerToys/_packaging/PowerToysPublicDependencies/nuget/v3/index.json" />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be reverted

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Product-Command Palette Refers to the Command Palette utility

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CmdPal: Track changes to Command Palette SDK API

1 participant