trambui09 / common-protos-ruby

Ruby protocol buffer classes generated from https://github.com/googleapis/api-common-protos

Common Protos Ruby

This repository is a home for the protocol buffer types which are common dependencies throughout the Google API ecosystem, generated for Ruby. The protobuf definitions for these generated Ruby classes are provided in the API Common Protos repository.

Using these generated classes

See googleapis-common-protos and googleapis-common-protos-types.

These packages are also available from rubygems:

• https://rubygems.org/gems/googleapis-common-protos
• https://rubygems.org/gems/googleapis-common-protos-types

Updating the gems

To add, remove, or modify the common types in these gems do the following.

1. Update the sub-module containing all of Google's public .proto files:

   $ git submodule update --remote googleapis

2. If necessary, update the list of protos to include. These are globs in the PROTO_GLOBS array in the library's Toys script (e.g. for message types: googleapis-common-protos-types/.toys.rb). This is needed only if new directories are added (which should be rare).

3. Compile new proto classes. This can be run at the top level to recompile all gems, or in a gem's directory to recompile only that one.

   $ toys compile

4. Update Gem version (which is located in the .gemspec file), and write an entry in the CHANGELOG.md. Create and merge a PR for this, and tag it with the gem name and version.

5. Build and release the gem:

   $ cd $GEM_TO_RELEASE
   $ toys release