Skip to content

Add API proposal version check#300392

Merged
alexr00 merged 6 commits intomainfrom
alexr00/fancy-flyingfish
Mar 10, 2026
Merged

Add API proposal version check#300392
alexr00 merged 6 commits intomainfrom
alexr00/fancy-flyingfish

Conversation

@alexr00
Copy link
Member

@alexr00 alexr00 commented Mar 10, 2026

No description provided.

Copilot AI review requested due to automatic review settings March 10, 2026 09:39
@alexr00 alexr00 self-assigned this Mar 10, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new GitHub Actions workflow to detect and gate API proposal // version: changes in src/vscode-dts/vscode.proposed.*.d.ts files, aiming to discourage unnecessary proposal version bumps and require explicit acknowledgement when they occur.

Changes:

  • Introduces API Proposal Version Check workflow triggered on PRs that touch proposed API d.ts files.
  • Detects proposal // version: changes, posts/updates a PR warning comment, and fails the check unless an override comment is present.
  • Adds an issue_comment trigger intended to allow unblocking via a slash command.

@github-actions
Copy link

github-actions bot commented Mar 10, 2026

⚠️ API Proposal Version Change Detected

The following proposed API files have version changes: vscode.proposed.chatDebug.d.ts

API proposal version changes should only be used when maintaining compatibility is not possible. Consider keeping the version as is and maintaining backward compatibility.

Any version changes must be updated by the consuming extensions before the next insiders for the extension to work.


If the version change is required, comment /api-proposal-change-required to unblock this check and acknowledge that you will update any critical consuming extensions (Copilot Chat).

@alexr00 alexr00 requested a review from sandy081 March 10, 2026 10:01
@alexr00 alexr00 marked this pull request as ready for review March 10, 2026 10:01
@alexr00 alexr00 removed the request for review from sandy081 March 10, 2026 10:01
@vs-code-engineering vs-code-engineering bot added this to the 1.112.0 milestone Mar 10, 2026
@alexr00 alexr00 merged commit cba3c7a into main Mar 10, 2026
19 checks passed
@alexr00 alexr00 deleted the alexr00/fancy-flyingfish branch March 10, 2026 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants