Skip to content

TypeScript protobuf code auto-generated with Github Actions

Notifications You must be signed in to change notification settings

kevinmichaelchen/some-protos-ts

Repository files navigation

some-protos-ts

CI

A repo containing TypeScript code compiled from protobufs contained in some-protos.

This build is powered by the ts-proto library.

Using this code with nice-grpc

To see this code being used in a sample Typescript app with nice-grpc, check out some-protos-ts-example.

Tuning the TypeScript Transpiler

There are lots of build options worth considering:

  • context=true — allows for a Go-style ctx parameter for logging and tracing
  • forceLong=long — all 64-bit numbers will be parsed with the long library
  • and more

Semantic-Release

Git-tagging, version management, and artifact/package publishing is handled by semantic-release.

Inspired by this demo repo.

Secrets

I don't think I really needed any environment-specific secrets, so all of these could probably by repository secrets rather than environment secrets.

  • NPM_TOKEN was an automation token created in NPM
  • ACCESS_TOKEN was a Github personal access token created with repo scope — this allowed the build to commit and push back auto-generated protobuf changes.
  • GITHUB_TOKEN is used, but not something we generated since it's automatically provided.