google/protobuf-gradle-plugin

Add example project to demonstrate project structure of multi-project builds

Open

#386 opened on Feb 3, 2020

View on GitHub
 (7 comments) (9 reactions) (0 assignees)Groovy (1,832 stars) (287 forks)batch import
examplehelp wanted

Description

Most real-life projects contain multiple subprojects, it would be good to have an example showing where proto files should be located (the general way) for each subproject and how this plugin should be applied for multi-project builds.

Contributor guide

Tech stack
groovy
Domain
documentationbuild system
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Gradle multi project buildsProtobuf basicsPlugin configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine existing example projects in the repository, such as examples/example1. Review the plugin's documentation on multi project builds and the configuration DSL. Look at the discussions in the issue comments for specific requirements. Create a new example directory with a root project and subprojects, showing where proto files (src/main/proto) should be placed and how to apply the plugin in each subproject's build.gradle.