Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Have a PR check for when a proposed API is added but the VS Code engine isn't changed #20939

Open
brettcannon opened this issue Mar 29, 2023 · 0 comments · May be fixed by #24586
Open

Have a PR check for when a proposed API is added but the VS Code engine isn't changed #20939

brettcannon opened this issue Mar 29, 2023 · 0 comments · May be fixed by #24586
Labels
area-internal Label for non-user facing issues debt Covers everything internal: CI, testing, refactoring of the codebase, etc. needs proposal Need to make some design decisions

Comments

@brettcannon
Copy link
Member

E.g. avoid the issues we had when we were bumping the proposed API for telemetry and forgetting to bump the VS Code engine accordingly.
@brettcannon brettcannon added debt Covers everything internal: CI, testing, refactoring of the codebase, etc. needs proposal Need to make some design decisions area-internal Label for non-user facing issues labels Mar 29, 2023
eleanorjboyd added a commit that referenced this issue Dec 11, 2024
@eleanorjboyd
Add PR check for proposed API changes
4a00aa6 
Fixes #20939

Add a PR check for proposed API changes without VS Code engine update.

* Modify `package.json` to add a new script entry `check-proposed-api`.
* Modify `.github/workflows/pr-file-check.yml` to add a new step to run the `check-proposed-api` script.
* Add `src/check-proposed-api.js` to check for changes in `enabledApiProposals` and `vscode` engine version, and fail if `enabledApiProposals` is modified but `vscode` engine version is not updated.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/microsoft/vscode-python/issues/20939?shareId=XXXX-XXXX-XXXX-XXXX).
@eleanorjboyd eleanorjboyd linked a pull request Dec 11, 2024 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area-internal Label for non-user facing issues debt Covers everything internal: CI, testing, refactoring of the codebase, etc. needs proposal Need to make some design decisions
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add PR check for proposed API changes microsoft/vscode-python
1 participant
@brettcannon