decouple gitpod-protocol from public-api #19151
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Removed dependencies detected. Learn more about Socket for GitHub ↗︎ 🚮 Removed packages: @testdeck/[email protected] |
to prevent rebuilding of components which dependent on gitpod-protocol, but not public-api on an API change
akosyakov
force-pushed
the
ak/public_api_decouple_protocol
branch
from
4db6e0d to
b9d062e
Compare
akosyakov
commented
Nov 28, 2023
| "ts" | ||
| ], | ||
| "exit": true | ||
| "build:esm": "tsc --module es2015 --outDir ./lib/esm" | ||
| }, | ||
| "dependencies": { | ||
| "@connectrpc/connect-node": "1.1.2", |
There was a problem hiding this comment.
it is unrelated, but these dependencies are not strictly required, and not necessary in case of browser for instance
There was a problem hiding this comment.
I have a feeling we are better to remove it and let a client to decide which version to use in their context.
geropl
reviewed
Nov 29, 2023
| @@ -0,0 +1,36 @@ | |||
| { | |||
| "name": "@gitpod/public-api-common", | |||
There was a problem hiding this comment.
@akosyakov Personally I would love to see a README.md next to this file, which explains the "WHY does this package exist, how it compares to gitpod-protocol, and "which package to choose for what"".
Can be a follow-up 👍
|
/unhold |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
To prevent rebuilding of components which dependent on gitpod-protocol, but not public-api on an API change, e.g. supervisor and ws-manager-bridge.
Summary generated by Copilot
🤖[deprecated] Generated by Copilot at 4db6e0d
This pull request refactors the public API code to use a new
@gitpod/public-api-commonpackage that contains common types and utilities for TypeScript clients. It also updates the imports and dependencies of thecomponents/dashboardandcomponents/gitpod-protocolpackages accordingly. The goal of this refactoring is to avoid circular dependencies and duplication in the public API code.Related Issue(s)
Fixes #
How to test
Smoke test against JSON-RPC and gRPC.
Documentation
Preview status
https://ak-public-e21d393f1f.preview.gitpod-dev.com/workspaces
Build Options
Build
Run the build with werft instead of GHA
Run Leeway with
--dont-testPublish
Installer
Add desired feature flags to the end of the line above, space separated
Preview Environment / Integration Tests
If enabled this will build
install/previewIf enabled this will create the environment on GCE infra
Saves cost. Untick this only if you're really sure you need a non-preemtible machine.
Valid options are
all,workspace,webapp,ide,jetbrains,vscode,ssh. If enabled,with-previewandwith-large-vmwill be enabled./hold