Added gRPC functions to manage libraries in profiles #3019
Conversation
cmaglie
added
type: enhancement
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## master #3019 +/- ##
==========================================
- Coverage 68.36% 67.47% -0.90%
==========================================
Files 241 246 +5
Lines 22731 23046 +315
==========================================
+ Hits 15541 15551 +10
- Misses 5992 6294 +302
- Partials 1198 1201 +3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
As stated by @per1234: > Build profile data is already provided via the LoadSketch method, so it > seems that even a mechanism that is truly for getting profile data should > be implemented by simply expanding the SketchProfile message to contain > all the data of the build profile (actually kind of silly that it > currently only provides a subset of the profile data). arduino#3019 (comment)
| // Name of the library. | ||
| string name = 1; | ||
| // Version of the library if taken from the Library Index. | ||
| string version = 2; |
There was a problem hiding this comment.
Clients would love to use a dedicated message to add the latest version of the library (without listing the available versions), and maybe add the currently installed version that errors if the library is not installed.
| rpc SettingsSetValue(SettingsSetValueRequest) returns (SettingsSetValueResponse); | ||
|
|
||
| // Create the sketch project file and add a build profile to it. | ||
| rpc InitProfile(InitProfileRequest) returns (InitProfileResponse) {} |
There was a problem hiding this comment.
Please reconsider the naming. ProfileInit would match better the other profile-related methods. ProfileCreate would be even better. Initializing a profile would infer installing the libs and platforms. InitProfileRequest -> ProfileCreateRequest, etc.
| string protocol = 6; | ||
| } | ||
|
|
||
| message SketchProfileLibraryReference { |
There was a problem hiding this comment.
Please consider dropping the Sketch prefix from the profile or using it consistently everywhere. Thank you
3 participants
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)configuration.schema.jsonupdated if new parameters are added.What kind of change does this PR introduce?
This is an extract of #2917 containing only the gRPC part of the PR.
What is the current behavior?
Adds only the gRPC functions for managing libraries in profiles, no user-facing changes.
What is the new behavior?
Does this PR introduce a breaking change, and is titled accordingly?
No
Other information