[CI] Add Github publishing (#49)

This adds release support to Github. When we create a release `tag` this will publish a new version of the plugin. For now, this does not publish `SNAPSHOT` builds as there's currently lots of work happening here.

This does require us to add the correct environment variables to this repo.

Author: Nava2

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Release
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  JVM-Run-Gradle-Release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: 'temurin'
+
+      - uses: actions/checkout@v3
+
+      # Given we are doing a release, lets make sure we have a safe gradle install
+      - uses: gradle/wrapper-validation-action@v1
+
+      - uses: gradle/gradle-build-action@v2
+
+      - name: Verify all checks pass
+        run: ./gradlew check
+
+      - name: Publish plugin
+        run: ./gradlew publishPlugins
+        env:
+          GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }}
+          GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }}

.travis.yml

@@ -1,9 +1,7 @@
 # AssertJ Generator Gradle Plugin
 
-[![Linux Build Status](https://travis-ci.org/assertj/assertj-generator-gradle-plugin.svg?branch=master)](https://travis-ci.org/assertj/assertj-generator-gradle-plugin)
-[![Windows status](https://ci.appveyor.com/api/projects/status/ia2ki6wprow9ysnl/branch/master?svg=true)](https://ci.appveyor.com/project/Nava2/assertj-generator-gradle-plugin/branch/master)
-
-[Gradle Plugin Portal](https://plugins.gradle.org/plugin/org.assertj.generator.gradle.plugin)
+![Build Status](https://img.shields.io/github/actions/workflow/status/assertj/assertj-generator-gradle-plugin/ci.yml)
+[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/org.assertj.generator)](https://plugins.gradle.org/plugin/org.assertj.generator.gradle.plugin)
 
 This is the source for the Gradle plugin for the
 [AssertJ Generator](http://joel-costigliola.github.io/assertj/assertj-assertions-generator.html). This plugin leverages
@@ -17,16 +15,16 @@ the [AssertJ Generator Maven Plugin](http://joel-costigliola.github.io/assertj/a
 Below is a minimal configuration that will cause _all_ classes defined in the `main` source set to have an `AssertJ`
 assertion generated for it. All of these will be placed into the highest package in use.
 
-This plugin requires Gradle 4.0.
+This plugin is built with Gradle 7.6.
 
-```gradle
+```groovy
 plugins {
   id 'org.assertj.generator' version '0.0.6b'
 }
 
 sourceSets {
   main {
-      // must specify assertJ block to have it applied
+      // Configurations are per source-set
       assertJ { }
   }
 }
@@ -60,19 +58,6 @@ The plugin version is tied to the version of
 the [AssertJ Generator](http://joel-costigliola.github.io/assertj/assertj-assertions-generator.html).
 The version of the generator used will always match the plugin's version.
 
-### Scope: Local vs. Global
-
-This plugin allows the generation configuration to appear in two places:
-
-* "global" `assertJ {}` block -- outside `sourceSets`
-* Locally within a `sourceSet` in an `assertJ {}` block (e.g. within `main{}`)
-
-All "locally" defined parameters override those set in the "global" scope.
-
-Each of these provide the same configuration parameters except:
-
-* Globally, files and patterns can not be manipulated -- this must be done at the local scope
-
 ### Parameters
 
 The following sections outline the available parameters, linking to the appropriate generator docs when available.
@@ -81,23 +66,22 @@ For any unlisted parameters, please see the
 [javadoc for `AssertJGeneratorOptions`](./src/main/groovy/org/assertj/generator/gradle/tasks/AssertJGeneratorOptions.groovy)
 and open issues for unclear/missing documentation.
 
-#### P: skip - `boolean`
+#### skip - `boolean`
 
-Default: `true`
+Default: `false`
 
 The `skip` parameter provides a mechanism for quickly turning on/off `assertJ` generation. Unless overridden in the
 global scope, no code will be generated by default. When an `assertJ` block is defined in a local scope, this parameter
 is set to `false` for the source set.
 
 ##### Example
 
-The following example turns on generation for _only_ `main` All classes found within `main` and `test` will have an
-Assertion generated. This is the recommended way to turn on generation for source sets.
+The following example turns _off_ generation for `main`. All classes found within `main` will be ignored.
 
-```gradle
+```groovy
 sourceSets {
   main {
-    assertJ { } // sets skip = false for the "main" sourceSet
+    assertJ { skip = true } // sets skip = true
   }
   test { }
 }
@@ -106,12 +90,8 @@ sourceSets {
 If debugging a build, it may be useful to turn off generation for a `sourceSet`. To do this, inside the configuration
 block, set `skip = true`.
 
-```gradle
+```groovy
 sourceSets {
-  main {
-    assertJ { } // sets skip = false for the "main" sourceSet
-  }
-
   brokenGeneration {
     assertJ {
       skip = true // no assertions will be generated for
@@ -124,7 +104,7 @@ sourceSets {
 }
 ```
 
-#### P: outputDir - `File`
+#### outputDir - `File`
 
 Default: `${buildDir}/generated-srcs/${sourceSet.name}-test/java`
 
@@ -138,19 +118,19 @@ The following example changes the output directory for _all_ source sets to be
 `${buildDir}/src-gen/${sourceSet.testName}/java/`. The same change could be applied to a local
 scope.
 
-```gradle
+```groovy
 sourceSets {
   main {
     // turn on assertJ generation
     assertJ { 
-      // default: generated-srcs/${SOURCE_SET_NAME_TAG}/java
+      // default: ${buildDir}/generated-srcs/${sourceSet.name}-test/java
       outputDir = file("src-gen/main-test/java")
     } 
   }
 }
 ```
 
-#### P: templates - `Templates`
+#### templates - `Templates`
 
 Default: Built-in templates
 
@@ -164,12 +144,12 @@ For more information on template syntax, please see the
 [AssertJ Generator Templates Section](http://joel-costigliola.github.io/assertj/assertj-assertions-generator.html#generated-assertions-templates).
 
 The names of templates mirror those from the AssertJ Documentation, but the actual names and nesting are listed
-[here](src/main/groovy/org/assertj/generator/gradle/tasks/config/Templates.groovy).
+[here](src/main/kotlin/org/assertj/generator/gradle/tasks/config/Templates.kt).
 
 The following example replaces the whole number field with a custom template for only the `main` sourceSet, any others
 remain unaffected.
 
-```gradle
+```groovy
 sourceSets {
   main {
     assertJ {
@@ -183,9 +163,11 @@ sourceSets {
 }
 ```
 
-The following example changes the template to a `file()` template for the `main` source sets.
+The following example changes the template to a `file()` template for the `main` source sets. The `file()` method
+accepts any parameter allowed by
+[`Project#file(...)`](https://docs.gradle.org/current/dsl/org.gradle.api.Project.html#org.gradle.api.Project:file(java.lang.Object)).
 
-```gradle
+```groovy
 sourceSets {
   main {
     assertJ {
@@ -202,7 +184,7 @@ sourceSets {
 
 We can root all files under a directory by using a file from the scoped `project`:
 
-```gradle
+```groovy
 sourceSets {
   main {
     assertJ {
@@ -219,9 +201,9 @@ sourceSets {
 }
 ```
 
-#### P: entryPoints - `EntryPointsGeneratorOptions`
+#### entryPoints - `EntryPointsGeneratorOptions`
 
-Default: Only generate "standard" assertions
+Default: Only generate "standard" assertion entrypoint
 
 Entry points are classes that provide mechanisms to get access to all of the generated AssertJ types.
 The [AssertJ Generator - Entry Points](http://joel-costigliola.github.io/assertj/assertj-assertions-generator.html#generated-entry-points)
@@ -238,7 +220,7 @@ value to entry point:
 By default, only the `standard` style is turned on. To adjust this, simply set the values to `true` within the
 `entryPoints` closure.
 
-```gradle
+```groovy
 sourceSets {
   main {
     assertJ {
@@ -254,7 +236,7 @@ sourceSets {
 
 A useful trick to turn on _only_ a set of values is to just set the `entryPoints` to a collection of types:
 
-```gradle
+```groovy
 sourceSets {
     main {
         assertJ {
@@ -266,7 +248,7 @@ sourceSets {
 
 Or within the `entryPoints` closure:
 
-```gradle
+```groovy
 sourceSets {
     main {
         assertJ {