Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.6 KB

UPDATING.md

File metadata and controls

35 lines (21 loc) · 1.6 KB

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

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

One-Time Setup

  1. Download and install Docker

Every time gtfs-realtime.proto changes

  1. Run the update script:

    ./update_generated_code.sh

  2. Add the license header back to the generated source file.

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

  1. Create a new branch from the master branch and use it to push a commit to change to release version (i.e., without the -SNAPSHOT).
  2. Open a PR with this release version and merge it in the master branch.
  3. Create a tag with the name and release version gtfs-realtime-bindings-java-[X].[Y].[Z] (Note the addition of -java)
  4. Create a new branch from the master branch and use it to push a commit to change to the next snapshot version (e.g., from 0.0.1 to 0.0.2-SNAPSHOT).
  5. Open a PR with this snapshot version and merge it in the master branch.