-
Notifications
You must be signed in to change notification settings - Fork 5
ci: generate ts typings for grpc client stub #232
Conversation
7a01321
to
0848663
Compare
0848663
to
4c15782
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you rename the github action workflow to gRPC client stubs generation
as we could add more language to this workflow at some point.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
Codecov Report
@@ Coverage Diff @@
## main #232 +/- ##
==========================================
- Coverage 59.85% 59.53% -0.32%
==========================================
Files 171 170 -1
Lines 9752 9644 -108
==========================================
- Hits 5837 5742 -95
+ Misses 3915 3902 -13 |
0ea8843
to
bc24941
Compare
06efde5
to
cb73631
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks for the detailed write-up!
Just wondering if there is a scenario where the types of the JS gRPC client could be newer than the current release? Merging with main
doesn't mean release, so the first logic seem to make more sense to me (because now we could have a situation with unreleased, but updated types in main
the JS client is using, but the currently deployed topos
network is not yet using).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks for the detailed write-up!
Just wondering if there is a scenario where the types of the JS gRPC client could be newer than the current release? Merging with main
doesn't mean release, so the first logic seem to make more sense to me (because now we could have a situation with unreleased, but updated types in main
the JS client is using, but the currently deployed topos
network is not yet using).
Housekeeping: This was replied on Slack |
Description
#229 introduced JavaScript gRPC client stubs generation through a new CI workflow. This PR adds the generation of TypeScript typings so that TypeScript clients can better use our client stubs.
Additionally, this PR changes the npm package publication flow to the following one:
main
contains changes to protobuf filesmain
, thenpm publish
step is run if the above was successfulTesting this new logic:
Additions and Changes
grpc_tools_node_protoc_ts
npm package as depprotoc
in the CI workflowprotoc
with a bin packaged ingrpc_tools_node_protoc_ts
to generate typings0.1.1
PR Checklist: