Merge pull request #78 from SpineEventEngine/release/v1.7.0

Release v1.7.0

Author: yuri-sergiichuk

.codacy.yaml

@@ -1,6 +1,12 @@
 #
 # Copyright 2020, TeamDev. All rights reserved.
 #
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
 # Redistribution and use in source and/or binary forms, with or without
 # modification, must retain the above copyright notice and the following
 # disclaimer.

.gitignore

@@ -1,52 +1,66 @@
 # bootstrap
 
-[![Build Status](https://travis-ci.com/SpineEventEngine/bootstrap.svg?branch=master)](https://travis-ci.com/SpineEventEngine/bootstrap)
+[![Build Status][badge]](https://travis-ci.com/SpineEventEngine/bootstrap)
 
 The Gradle plugin for bootstrapping projects built with Spine.
 
+[badge]: https://travis-ci.com/SpineEventEngine/bootstrap.svg?branch=master
+
 ## Applying to the project
 
 In order to apply the plugin to a Gradle project, in `build.gralde` add the following config:
+
 ```gradle
 plugins {
-    id("io.spine.tools.gradle.bootstrap").version("1.6.0")
+    id("io.spine.tools.gradle.bootstrap").version("1.7.0")
 }
 ```
 
-See [this Gradle doc](https://docs.gradle.org/current/userguide/plugins.html#sec:subprojects_plugins_dsl)
-on how to apply a plugin only to certain to subprojects.
+See [this Gradle doc][gradle-plugins-dsl] on how to apply a plugin only to certain to subprojects.
+
+[gradle-plugins-dsl]: https://docs.gradle.org/current/userguide/plugins.html#sec:subprojects_plugins_dsl
 
 ## Java Projects
 
 In order to mark a (sub-)project as a Java project for Spine, apply the following config:
+
 ```gradle
 spine.enableJava()
 ```
 
 This configuration:
+
  - applies `java` Gradle plugin;
+   
  - applies `com.google.protobuf` Gradle plugin;
+   
  - configures Java code generation from Protobuf;
+   
  - adds a dependency onto the `io.spine:spine-base` module;
+   
  - applies the Spine Model Compiler plugin and performs its minimal configuration.
 
 More often than not, a user would also like to mark a Java project as a client or a server module.
 To do that, apply the following configuration:
- - for client modules:
-```gradle
-spine.enableJava().client()
-```
- - for server modules:
-```gradle
-spine.enableJava().server()
-```
+
+- for client modules:
+   
+    ```gradle
+    spine.enableJava().client()
+    ```
+
+- for server modules:
+    ```gradle
+    spine.enableJava().server()
+    ```
 
 This config will add required dependencies for developing a Spine-based Java client and server 
 respectively.
 
 ### Obtaining the version when adding other dependencies
 
-In order to use the same version for other Spine libraries, please use `sine.version()`. For example, adding testing utilities would look like this:
+In order to use the same version for other Spine libraries, please use `spine.version()`. 
+For example, adding testing utilities would look like this:
 
 ```gradle
 dependencies {
@@ -62,6 +76,7 @@ Spine relies on [gRPC](https://grpc.io/).
 All the required gRPC Java stubs and services are already included into the Spine artifacts. 
 However, if users would like to declare gRPC services of their own, they may use the following 
 configuration to set up the generation seamlessly:
+
 ```gradle
 spine.enableJava {
     codegen {
@@ -81,6 +96,7 @@ is not added by default in order not to cause clashes in the user projects.
 
 Sometimes, the users might not want any Java code to be generated. For such cases, the plugin 
 provides following configuration opportunity:
+
 ```gradle
 spine.enableJava {
     codegen {
@@ -89,11 +105,13 @@ spine.enableJava {
     }
 }
 ```
+
 This way, no Java code will be generated at all, including Protobuf messages, gRPC services, 
 validating builders, and rejections.
 
 A user also may leave the Java Protobuf codegen enabled, but only turn off Spine-specific code 
 generation:
+
 ```gradle
 spine.enableJava {
     codegen {
@@ -105,6 +123,7 @@ spine.enableJava {
 ## JavaScript Projects
 
 In order to mark a (sub-)project as a JS project for Spine, apply the following config:
+
 ```gradle
 spine.enableJavaScript()
 ```
@@ -114,3 +133,17 @@ This configuration:
  - configures JS code generation from Protobuf.
 
 If only JS generation is configured, the Java code will not be generated (and the other way around).
+
+## Dart Projects
+
+In order to mark a (sub-)project as a Dart project for Spine, apply the following config:
+
+```gradle
+spine.enableDart()
+```
+
+This configuration:
+- applies `com.google.protobuf` and `java` Gradle plugin (as the former depends on the latter);
+- configures Dart code generation from Protobuf.
+
+If only Dart generation is configured, the Java code will not be generated (and the other way around).

.idea/copyright/TeamDev_Open_Source.xml

@@ -1,6 +1,12 @@
 /*
  * Copyright 2020, TeamDev. All rights reserved.
  *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
  * Redistribution and use in source and/or binary forms, with or without
  * modification, must retain the above copyright notice and the following
  * disclaimer.

README.md

@@ -1,6 +1,12 @@
 /*
  * Copyright 2020, TeamDev. All rights reserved.
  *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
  * Redistribution and use in source and/or binary forms, with or without
  * modification, must retain the above copyright notice and the following
  * disclaimer.

build.gradle.kts

@@ -1,6 +1,12 @@
 /*
  * Copyright 2020, TeamDev. All rights reserved.
  *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
  * Redistribution and use in source and/or binary forms, with or without
  * modification, must retain the above copyright notice and the following
  * disclaimer.

buildSrc/build.gradle.kts

@@ -1,6 +1,12 @@
 /*
  * Copyright 2020, TeamDev. All rights reserved.
  *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
  * Redistribution and use in source and/or binary forms, with or without
  * modification, must retain the above copyright notice and the following
  * disclaimer.

buildSrc/src/main/kotlin/bootstrap-plugin.gradle.kts

@@ -1,6 +1,12 @@
 /*
  * Copyright 2020, TeamDev. All rights reserved.
  *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
  * Redistribution and use in source and/or binary forms, with or without
  * modification, must retain the above copyright notice and the following
  * disclaimer.

buildSrc/src/main/kotlin/io/spine/gradle/internal/CheckVersionIncrement.kt

@@ -1,6 +1,12 @@
 /*
  * Copyright 2020, TeamDev. All rights reserved.
  *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
  * Redistribution and use in source and/or binary forms, with or without
  * modification, must retain the above copyright notice and the following
  * disclaimer.