search

SpineEventEngine / ProtoTap

Utilities for tapping `protoc` output
Apache License 2.0
0 stars 0 forks source link

Init project #1

Closed alexander-yevsyukov closed 5 months ago

alexander-yevsyukov commented 5 months ago

This PR initiates the project, providing first pre-1.0.0 draft for the implementation. The project uses the same development approach as the rest of Spine SDK sub-projects based on config submodule. Hence, the number of files in this PR.

Basic architecture

The ProtoTap consists of the following modules:

  1. api — constants and functions common to all modules.
  2. gradle-plugin — the Protobuf plugin which taps Protobuf Gradle plugin.
  3. protoc-plugin — the plugin to protoc responsible for tapping CodeGeneratorRequest.

Please see README.md for details on the usage of the Gradle plugin.

Version and publishing

The version selected for this PR is 0.8.0 meaning we expect that some changes may come from the usage experience before we put the 1.0.0 stamp on the thing. Though, we don't expect too many of them.

The version we put is not a snapshot, so the Gradle plugin is going to be submitted to Gradle Plugin portal, and since it is a new plugin, we expect the approval process.

Unlike ProtoData, ProtoTap uses newer (1.2.1) version of the com.gradle.plugin-publish plugin with shorter DSL. The procedure of the approval may also differ.