Skip to content
This repository has been archived by the owner on Oct 31, 2024. It is now read-only.

ci: add new grpc js client stubs generation CI workflow #229

Merged
merged 1 commit into from
May 12, 2023

Conversation

sebastiendan
Copy link
Member

@sebastiendan sebastiendan commented May 11, 2023

Description

This PR adds JavaScript client stub generation and packaging in a @topos-network/topos-grpc-client-stub npm package.

Client stubs can then be used in web applications for interactions with the gRPC API of a topos node.

Additions and Changes

  • Add package.json and package-lock.json files in the proto directory to identify and version the npm package
  • Add a CI workflow to generate stubs and package them in a new package to be published

Note: Packages are built and published on new Github releases. It's important to remember that the version of the package (specified in its package.json file) needs to be updated priori to the creation of the release on Github (otherwise package publication will fail and the release will have to be recreated).

Tagging @Freyskeyd @atanmarko @hadjiszs @gruberb to double-check this point above ⬆️

PR Checklist:

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added or updated tests that comprehensively prove my change is effective or that my feature works

@sebastiendan sebastiendan self-assigned this May 11, 2023
@sebastiendan sebastiendan force-pushed the ci/generate-grpc-js-client-stub branch 5 times, most recently from 93a388c to eb0819e Compare May 11, 2023 21:32
@sebastiendan sebastiendan force-pushed the ci/generate-grpc-js-client-stub branch from eb0819e to 17d4450 Compare May 11, 2023 21:34
@codecov
Copy link

codecov bot commented May 11, 2023

Codecov Report

Merging #229 (17d4450) into main (d659f92) will decrease coverage by 0.22%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #229      +/-   ##
==========================================
- Coverage   58.74%   58.53%   -0.22%     
==========================================
  Files         171      171              
  Lines        9970     9970              
==========================================
- Hits         5857     5836      -21     
- Misses       4113     4134      +21     

see 4 files with indirect coverage changes

@sebastiendan sebastiendan marked this pull request as ready for review May 11, 2023 21:57
@sebastiendan sebastiendan requested a review from a team as a code owner May 11, 2023 21:57
@sebastiendan sebastiendan requested review from Freyskeyd and gruberb May 11, 2023 21:57
Copy link
Member

@Freyskeyd Freyskeyd left a comment

Choose a reason for hiding this comment

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

For the version, we could manage that using a release manager on an xtask project

@Freyskeyd Freyskeyd merged commit 50226f8 into main May 12, 2023
@Freyskeyd Freyskeyd deleted the ci/generate-grpc-js-client-stub branch May 12, 2023 08:30
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants