Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 1.54 KB

UPDATING.md

File metadata and controls

41 lines (24 loc) · 1.54 KB
Raw

How-To Update Bindings When gtfs-realtime.proto Changes

Regenerate the language binding source from gtfs-realtime.proto.

One-Time Setup

  1. Download and setup Protocol Buffer release from https://github.com/protocolbuffers/protobuf/releases (if you haven't already done this for another language). As of February 2019 we're using v3.7 release, which is compatible with proto2 .proto files.
  2. Download Java JDK
  3. Download and install Maven

Every time gtfs-realtime.proto changes

Regenerate the language binding source from gtfs-realtime.proto.

From the project /java folder, run:

protoc --java_out=src/main/java --proto_path=.. ../gtfs-realtime.proto

Add the license header back to the generated source file.

Test the generated code:

mvn verify

Publishing a new release.

One-Time Setup

We're hosting releases on the Maven Central Repository.

Note that we are using GitHub actions to publish new releases. These are the steps that were followed for publishing the gtfs-realtime-bindings library on ossrh repository using GitHub actions.

To sign the application (required for publishing to Maven Central) we use a GPG key as described here.

Every release

TODO