Skip to content

Commit

Permalink
Merge pull request #78 from SpineEventEngine/release/v1.7.0
Browse files Browse the repository at this point in the history
Release v1.7.0
  • Loading branch information
yuri-sergiichuk authored Dec 16, 2020
2 parents ed3ea82 + e5e6fc0 commit 1eee27f
Show file tree
Hide file tree
Showing 53 changed files with 441 additions and 34 deletions.
3 changes: 0 additions & 3 deletions .codacy.yaml

This file was deleted.

6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion .idea/copyright/TeamDev_Open_Source.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

59 changes: 46 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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()
```
Expand All @@ -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).
6 changes: 6 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions buildSrc/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions buildSrc/src/main/kotlin/bootstrap-plugin.gradle.kts
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions buildSrc/src/main/kotlin/io/spine/gradle/internal/RunBuild.kt
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions buildSrc/src/main/kotlin/io/spine/gradle/internal/deps.kt
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 6 additions & 0 deletions buildSrc/src/main/kotlin/prepare-config-resources.gradle.kts
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion config
Submodule config updated 44 files
+6 −0 .gitignore
+1 −1 .idea/copyright/TeamDev_Open_Source.xml
+6 −0 gcs.properties
+6 −0 gradle/buildSrc/build.gradle.kts
+6 −0 gradle/buildSrc/src/main/kotlin/io/spine/gradle/internal/CheckVersionIncrement.kt
+6 −0 gradle/buildSrc/src/main/kotlin/io/spine/gradle/internal/IncrementGuard.kt
+6 −0 gradle/buildSrc/src/main/kotlin/io/spine/gradle/internal/RunBuild.kt
+6 −0 gradle/buildSrc/src/main/kotlin/io/spine/gradle/internal/deps.kt
+6 −0 gradle/checkstyle.gradle
+6 −0 gradle/dart/build-tasks.gradle
+6 −0 gradle/dart/pub-publish-tasks.gradle
+6 −0 gradle/dependencies.gradle
+6 −0 gradle/filter-internal-javadoc.gradle
+6 −0 gradle/generate-pom.gradle
+6 −0 gradle/jacoco.gradle
+6 −0 gradle/javac-args.gradle
+6 −0 gradle/javadoc-options.gradle
+6 −0 gradle/js/build-tasks.gradle
+6 −0 gradle/js/configure-proto.gradle
+6 −0 gradle/js/npm-cli.gradle
+6 −0 gradle/js/npm-publish-tasks.gradle
+6 −0 gradle/js/update-package-version.gradle
+6 −0 gradle/license-report-common.gradle
+6 −0 gradle/license-report-project.gradle
+6 −0 gradle/license-report-repo.gradle
+6 −0 gradle/model-compiler.gradle
+6 −0 gradle/pmd.gradle
+6 −0 gradle/publish-proto.gradle
+6 −0 gradle/publish.gradle
+6 −0 gradle/run-build.gradle
+6 −0 gradle/slow-tests.gradle
+6 −0 gradle/test-artifacts.gradle
+6 −0 gradle/test-output.gradle
+6 −0 gradle/update-gh-pages.gradle
+6 −0 pull
+7 −1 quality/checkstyle-suppressions.xml
+7 −0 quality/checkstyle.xml
+88 −80 quality/pmd.xml
+27 −1 scripts/publish-artifacts.sh
+26 −0 scripts/register-ssh-key.sh
+26 −0 scripts/trigger-publishing.sh
+27 −1 scripts/update-apt.sh
+27 −1 scripts/upload-artifacts.sh
+24 −0 scripts/util/remove_finals.py
6 changes: 6 additions & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 2 additions & 2 deletions license-report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@


# Dependencies of `io.spine.tools:spine-plugin:1.6.16`
# Dependencies of `io.spine.tools:spine-plugin:1.7.0`

## Runtime
1. **Group:** com.google.code.findbugs **Name:** jsr305 **Version:** 3.0.2
Expand Down Expand Up @@ -335,4 +335,4 @@
The dependencies distributed under several licenses, are used according their commercial-use-friendly license.


This report was generated on **Wed Dec 09 12:01:33 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
This report was generated on **Tue Dec 15 18:38:01 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
6 changes: 6 additions & 0 deletions plugin/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Loading

0 comments on commit 1eee27f

Please sign in to comment.