.github/workflows/gradle-wrapper-validation.yml

@@ -7,6 +7,6 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-      - uses: actions/checkout@v2
-      - uses: gradle/wrapper-validation-action@v1
+      - uses: actions/checkout@v4
+      - uses: gradle/actions/wrapper-validation@v3
 

.github/workflows/testing.yml

@@ -14,15 +14,15 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-java@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
         with:
           java-version: '11'
           distribution: 'temurin'
-      - uses: gradle/gradle-build-action@v2
-        with:
-          arguments: clean assemble --stacktrace
-        
+      - uses: gradle/actions/setup-gradle@v3
+      - name: Gradle Assemble
+        run: ./gradlew clean assemble --stacktrace
+
   test:
     needs: build
     strategy:
@@ -32,28 +32,28 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-java@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
         with:
           java-version: '11'
           distribution: 'temurin'
-      - uses: gradle/gradle-build-action@v2
-        with:
-          arguments: test --tests ${{ matrix.tests }} --stacktrace
+      - uses: gradle/actions/setup-gradle@v3
+      - name: Gradle Test
+        run: ./gradlew test --tests ${{ matrix.tests }} --stacktrace
 
   codenarc:
     needs: build
     runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-java@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
         with:
           java-version: '11'
           distribution: 'temurin'
-      - uses: gradle/gradle-build-action@v2
-        with:
-          arguments: codenarcMain codenarcTest --continue
+      - uses: gradle/actions/setup-gradle@v3
+      - name: Gradle Codenarc
+        run: ./gradlew codenarcMain codenarcTest --continue
       - name: echo codenarcMain reports
         if: failure()
         run: test -f build/reports/codenarc/main.txt && cat build/reports/codenarc/main.txt

README.md

@@ -17,31 +17,34 @@ For more information about the Protobuf Compiler, please refer to
 [Google Developers Site](https://developers.google.com/protocol-buffers/docs/reference/java-generated?csw=1).
 
 ## Latest Version
-The latest version is ``0.9.1``. It requires at least __Gradle 5.6__ and __Java 8__.
-It is available on Maven Central. To add dependency to it:
+The latest version is ``0.9.4``. It requires at least __Gradle 5.6__ and __Java 8__.
+To use it with Groovy DSL:
 ```gradle
-buildscript {
-  repositories {
-    gradlePluginPortal()
-  }
-  dependencies {
-    classpath 'com.google.protobuf:protobuf-gradle-plugin:0.9.1'
-  }
+plugins {
+  id "com.google.protobuf" version "0.9.4"
 }
 ```
 
+## Development Version
+
 To try out the head version, you can download the source and build it
 with ``./gradlew publishToMavenLocal -x test`` (we skip tests here because they
-require Android SDK), then:
+require Android SDK), then in `settings.gradle`:
 
 ```gradle
-buildscript {
+pluginManagement {
   repositories {
+    gradlePluginPortal()
     mavenLocal()
   }
-  dependencies {
-    classpath 'com.google.protobuf:protobuf-gradle-plugin:0.9.1-SNAPSHOT'
-  }
+}
+```
+
+And in `build.gradle`:
+
+```gradle
+plugins {
+  id "com.google.protobuf" version "0.9.5-SNAPSHOT"
 }
 ```
 
@@ -63,30 +66,6 @@ individual projects.
 This plugin must work with either the Java plugin or the Android plugin.
 
 
-### Using the `apply` method
-The Java plugin or the Android plugin must be applied before the Protobuf plugin:
-
-```gradle
-apply plugin: 'java'
-apply plugin: 'com.google.protobuf'
-```
-
-```gradle
-apply plugin: 'com.android.application'  // or 'com.android.library'
-apply plugin: 'com.google.protobuf'
-```
-
-### Using the Gradle plugin DSL
-The order of the plugins doesn't matter:
-
-```gradle
-plugins {
-  id "com.google.protobuf" version "0.9.1"
-  id "java"
-}
-```
-
-
 ## Configuring Protobuf compilation
 
 The Protobuf plugin assumes Protobuf files (``*.proto``) are organized in the
@@ -197,7 +176,8 @@ protobuf {
   // Locate the codegen plugins
   plugins {
     // Locate a plugin with name 'grpc'. This step is optional.
-    // If you don't locate it, protoc will try to use "protoc-gen-grpc" from
+    // If you leave it empty, it uses the current directory.
+    // If you don't specify it, protoc will try to use "protoc-gen-grpc" from
     // system search path.
     grpc {
       artifact = 'io.grpc:protoc-gen-grpc-java:1.0.0-pre2'
@@ -240,7 +220,7 @@ protobuf {
   ...
   generateProtoTasks {
     // all() returns the collection of all protoc tasks
-    all().each { task ->
+    all().configureEach { task ->
       // Here you can configure the task
     }
 
@@ -276,7 +256,7 @@ Each code generation task has two collections:
 #### Configure what to generate
 
 Code generation is done by protoc builtins and plugins.  Each
-builtin/plugin generate a certain type of code.  To add or configure a
+builtin/plugin generates a certain type of code.  To add or configure a
 builtin/plugin on a task, list its name followed by a braces block.
 Put options in the braces if wanted.  For example:
 
@@ -315,12 +295,10 @@ task.plugins {
 
 ```gradle
 protobuf {
-  generatedFilesBaseDir = "$projectDir/generated"
-
   generateProtoTasks {
-    all().each { task ->
+    all().configureEach { task ->
       task.builtins {
-        // Generates Python code in the output folder:
+        // Generates Python code
         python { }
 
         // If you wish to avoid generating Java files:
@@ -365,7 +343,7 @@ protobuf {
     }
   }
   generateProtoTasks {
-    all().each { task ->
+    all().configureEach { task ->
       task.builtins {
         // In most cases you don't need the full Java output
         // if you use the lite output.
@@ -393,7 +371,7 @@ protobuf {
     artifact = 'com.google.protobuf:protoc:3.8.0'
   }
   generateProtoTasks {
-    all().each { task ->
+    all().configureEach { task ->
       task.builtins {
         java {
           option "lite"
@@ -410,7 +388,7 @@ protobuf {
 ```gradle
 { task ->
   // If true, will generate a descriptor_set.desc file under
-  // $generatedFilesBaseDir/$sourceSet. Default is false.
+  // task.outputBaseDir. Default is false.
   // See --descriptor_set_out in protoc documentation about what it is.
   task.generateDescriptorSet = true
 
@@ -430,19 +408,11 @@ protobuf {
 
 #### Change where files are generated
 
-By default generated Java files are under
-``$generatedFilesBaseDir/$sourceSet/$builtinPluginName``, where
-``$generatedFilesBaseDir`` is ``$buildDir/generated/source/proto`` by default,
-and is configurable. E.g.,
-
-```gradle
-protobuf {
-  ...
-  generatedFilesBaseDir = "$projectDir/src/generated"
-}
-```
+Generated files are under `task.outputBaseDir` with a subdirectory per
+builtin and plugin. This produces a folder structure of
+``$buildDir/generated/sources/proto/$sourceSet/$builtinPluginName``.
 
-The subdirectory name, which is by default ``$builtinPluginName``, can also be
+The subdirectory name, which is by default ``$builtinPluginName``, can be
 changed by setting the ``outputSubDir`` property in the ``builtins`` or
 ``plugins`` block of a task configuration within ``generateProtoTasks`` block
 (see previous section). E.g.,
@@ -451,8 +421,7 @@ changed by setting the ``outputSubDir`` property in the ``builtins`` or
 { task ->
   task.plugins {
     grpc {
-      // Write the generated files under
-      // "$generatedFilesBaseDir/$sourceSet/grpcjava"
+      // Use subdirectory 'grpcjava' instead of the default 'grpc'
       outputSubDir = 'grpcjava'
     }
   }
@@ -521,29 +490,6 @@ This plugin integrates with the ``idea`` plugin and automatically
 registers the proto files and generated Java code as sources.
 
 
-```gradle
-apply plugin: 'idea'
-
-protobuf {
-    ...
-    generatedFilesBaseDir = "$projectDir/gen"
-}
-
-clean {
-    delete protobuf.generatedFilesBaseDir
-}
-
-idea {
-    module {
-        // proto files and generated Java files are automatically added as
-        // source dirs.
-        // If you have additional sources, add them here:
-        sourceDirs += file("/path/to/other/sources");
-    }
-}
-```
-
-
 ## Testing the plugin
 
 ``testProject*`` are testing projects that uses this plugin to compile