Merge branch 'release/1.1.0'

.github/workflows/default.yml

@@ -14,12 +14,12 @@ jobs:
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
 
-    - name: Set up JDK 1.8
+    - name: Set up JDK 11
       uses: actions/setup-java@v1
       with:
-        java-version: 1.8
+        java-version: 11
 
     - name: Cache .m2
       uses: actions/cache@v1

.github/workflows/master.yml

@@ -11,12 +11,12 @@ jobs:
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v1
+      uses: actions/checkout@v2
 
-    - name: Set up JDK 1.8
+    - name: Set up JDK 11
       uses: actions/setup-java@v1
       with:
-        java-version: 1.8
+        java-version: 11
 
     - name: Cache .m2
       uses: actions/cache@v1
@@ -53,7 +53,7 @@ jobs:
       run: ./mvnw clean deploy -B -DskipTests -DskipExamples -Prelease -Dgpg.keyname=${{secrets.GPG_KEYNAME}} -Dgpg.passphrase=${{secrets.GPG_PASSPHRASE}}
 
     - name: Build and deploy site docs
-      run: ./mvnw -Pdeploy-docs -f docs -DgithubToken=${{secrets.GH_TOKEN}}
+      run: ./mvnw -Pdeploy-docs -f docs -DgithubToken=${{secrets.GITHUB_TOKEN}}
 
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v1.0.2

README.adoc

@@ -51,20 +51,20 @@ If you just want to start using the library, put the following dependency into y
 <dependency>
   <groupId>io.holunda.data</groupId>
   <artifactId>camunda-bpm-data</artifactId>
-  <version>1.0.1</version>
+  <version>1.0.2</version>
 </dependency>
 ----
 
 If you are using Gradle Kotlin DSL add to your `build.gradle.kts`:
 [source,kotlin]
 ----
-implementation("io.holunda.data:camunda-bpm-data:1.0.1")
+implementation("io.holunda.data:camunda-bpm-data:1.0.2")
 ----
 
 For Gradle Groovy DSL add to your `build.gradle`:
 [source,groovy]
 ----
-implementation 'io.holunda.data:camunda-bpm-data:1.0.1'
+implementation 'io.holunda.data:camunda-bpm-data:1.0.2'
 ----
 
 === Variable declaration

docs/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.holunda.data</groupId>
     <artifactId>camunda-bpm-data-parent</artifactId>
-    <version>1.0.3-SNAPSHOT</version>
+    <version>1.1.0</version>
   </parent>
 
   <artifactId>camunda-bpm-data-docs</artifactId>

docs/src/orchid/resources/changelog/1.1/1.1.0.ad

@@ -0,0 +1,32 @@
+---
+version: 1.1.0
+---
+
+== Features
+
+* Improve Kotlin API with extension functions on `VariableMap` and `VariableScope`, see #58
+* Provides Kotlin operators for read/write from/on `VariableMap` and `VariableScope`, see #65
+* Support smart update (set variable only if the value changed), see #65
+* Provide `update` and `updateLocal` methods in `Writer` interface, see #70
+
+== Breaking Changes
+
+* Guard API follows conventions of VariableFactory API (adding `Local` to method name for local scope), #67
+
+== Bugfix
+
+* Fix docs generation of quickstart, see #73
+
+== Documentation
+
+* Include JavaDocs and KDocs into site, see #75
+
+== Chore
+
+* Switch to JDK 11
+* Upgrade to Kotlin 1.4.10 and Dokka 1.4.10, see #74
+* Upgrade to Kotlin 1.4.0, see #69
+* Upgrade to Camunda BPM 7.13, see #69
+* Upgrade to SpringBoot 2.3.2, see #69
+
+

docs/src/orchid/resources/config.yml

@@ -24,37 +24,32 @@ allPages:
         - 'show-language'
         - 'copy-to-clipboard'
 
-services:
-  publications:
-    stages:
-      - type: 'githubPages'
-        username: 'zambrovski'
-        repo: 'holunda-io/camunda-bpm-data'
-
-#
-# FIXME: move to separate file after 0.19 release of orchid
-#
-javadoc:
-  modules:
-    - name: Camunda BPM Data
-      sourceDirs:
-        - '../../../../extension/src/main/java'
+kotlindoc:
+  sourceDirs:
+    - './../../../../extension/core/src/main/kotlin'
+    - './../../../../extension/test/src/main/kotlin'
+  homePageOnly: false
   pages:
     menu:
       - type: 'sourcedocPageLinks'
-        moduleType: 'javadoc'
+        moduleType: 'kotlindoc'
         itemTitleType: 'SIGNATURE'
         includeItems: true
 
-kotlindoc:
-  modules:
-    - name: Camunda BPM Data Kotlin
-      sourceDirs:
-        - '../../../../extension-kotlin/src/main/kotlin'
+javadoc:
+  sourceDirs:
+    - './../../../../extension/core/src/main/java'
   pages:
     menu:
       - type: 'sourcedocPageLinks'
-        moduleType: 'kotlindoc'
+        moduleType: 'javadoc'
+        itemTitleType: 'SIGNATURE'
         includeItems: true
-        itemTitleType: 'NAME'
 
+
+services:
+  publications:
+    stages:
+      - type: 'githubPages'
+        username: 'holunda-io'
+        repo: 'holunda-io/camunda-bpm-data'

docs/src/orchid/resources/config/theme.yml

@@ -40,9 +40,19 @@ menu:
       - type: 'page'
         title: 'License'
         itemId: 'License'
-
   - type: 'sourcedocPages'
-    submenuTitle: 'JavaDoc All Packages'
     moduleType: 'javadoc'
     node: 'packages'
     asSubmenu: true
+    submenuTitle: 'Java Packages'
+  - type: 'sourcedocPages'
+    moduleType: 'kotlindoc'
+    node: 'packages'
+    asSubmenu: true
+    submenuTitle: 'Kotlin Packages'
+
+#  - type: 'sourcedocModules'
+#    submenuTitle: 'JavaDoc All Packages'
+#    moduleType: 'javadoc'
+#    node: 'packages'
+

docs/src/orchid/resources/pages/quick-start.ad

@@ -1,8 +1,6 @@
 ---
-
 title: Quick Start
 pageId: 'quick-start'
-
 ---
 
 == {{ page.title }}
@@ -16,20 +14,20 @@ In Apache Maven add to your `pom.xml`:
 <dependency>
   <groupId>io.holunda.data</groupId>
   <artifactId>camunda-bpm-data</artifactId>
-  <version>{{ site:version }}</version>
+  <version>${camunda-bpm-data.version}</version>
 </dependency>
 ----
 
 For Gradle Kotlin DSL add to your `build.gradle.kts`:
 [source,kotlin]
 ----
-implementation("io.holunda.data:camunda-bpm-data:{{ site:version }}")
+implementation("io.holunda.data:camunda-bpm-data:${camunda-bpm-data.version}")
 ----
 
 For Gradle Groovy DSL add to your `build.gradle`:
 [source,groovy]
 ----
-implementation 'io.holunda.data:camunda-bpm-data:{{ site:version }}'
+implementation 'io.holunda.data:camunda-bpm-data:${camunda-bpm-data.version}'
 ----
 
 === Declare process variable factories

docs/src/orchid/resources/wiki/user-guide/examples-kotlin.ad

@@ -209,7 +209,7 @@ class SomeService {
     );
 
   fun correlate() {
-      val variables = CamundaBpmData.writer()
+      val variables = CamundaBpmData.builder()
           .set(ORDER_ID, "4711")
           .set(ORDER_APPROVED, false)
           .build();

example/coverage-report-aggregator/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.holunda.data.example</groupId>
     <artifactId>camunda-bpm-data-example-parent</artifactId>
-    <version>1.0.3-SNAPSHOT</version>
+    <version>1.1.0</version>
   </parent>
 
   <artifactId>camunda-bpm-data-coverage-report</artifactId>

example/example-java/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>io.holunda.data.example</groupId>
     <artifactId>camunda-bpm-data-example-parent</artifactId>
-    <version>1.0.3-SNAPSHOT</version>
+    <version>1.1.0</version>
   </parent>
 
   <artifactId>camunda-bpm-data-example-java</artifactId>

example/example-java/src/main/java/io/holunda/camunda/bpm/data/example/domain/Order.java

@@ -30,8 +30,9 @@ public Order() {
 
   /**
    * Constructor to pass all member attributes.
-   * @param orderId order id
-   * @param created creation date
+   *
+   * @param orderId   order id
+   * @param created   creation date
    * @param positions list of positions.
    */
   public Order(String orderId, Date created, List<OrderPosition> positions) {
@@ -42,6 +43,7 @@ public Order(String orderId, Date created, List<OrderPosition> positions) {
 
   /**
    * Sets the order id.
+   *
    * @param orderId order id to set.
    */
   public void setOrderId(String orderId) {
@@ -50,6 +52,7 @@ public void setOrderId(String orderId) {
 
   /**
    * Sets the created date.
+   *
    * @param created created date to set.
    */
   public void setCreated(Date created) {
@@ -58,6 +61,7 @@ public void setCreated(Date created) {
 
   /**
    * Sets the order positions.
+   *
    * @param positions list of positions to set.
    */
   public void setPositions(List<OrderPosition> positions) {
@@ -66,6 +70,7 @@ public void setPositions(List<OrderPosition> positions) {
 
   /**
    * Retrieves the order id.
+   *
    * @return order id.
    */
   public String getOrderId() {
@@ -74,6 +79,7 @@ public String getOrderId() {
 
   /**
    * Retrieves the created date.
+   *
    * @return date of create.
    */
   public Date getCreated() {
@@ -82,6 +88,7 @@ public Date getCreated() {
 
   /**
    * Retrieves the list of positions.
+   *
    * @return list of positions.
    */
   public List<OrderPosition> getPositions() {
@@ -119,9 +126,9 @@ public int hashCode() {
   @Override
   public String toString() {
     return "Order{" +
-        "orderId='" + orderId + '\'' +
-        ", created=" + created +
-        ", positions=" + positions +
-        '}';
+      "orderId='" + orderId + '\'' +
+      ", created=" + created +
+      ", positions=" + positions +
+      '}';
   }
 }

example/example-java/src/main/java/io/holunda/camunda/bpm/data/example/domain/OrderPosition.java

@@ -28,9 +28,10 @@ public OrderPosition() {
 
   /**
    * Constructor setting fields.
-   * @param title title of position.
+   *
+   * @param title   title of position.
    * @param netCost net cost per unit.
-   * @param amount amount of units.
+   * @param amount  amount of units.
    */
   public OrderPosition(String title, BigDecimal netCost, Long amount) {
     this.title = title;
@@ -40,6 +41,7 @@ public OrderPosition(String title, BigDecimal netCost, Long amount) {
 
   /**
    * Retrieves title.
+   *
    * @return position title.
    */
   public String getTitle() {
@@ -48,6 +50,7 @@ public String getTitle() {
 
   /**
    * Retrieves net cost per unit.
+   *
    * @return net cost per unit.
    */
   public BigDecimal getNetCost() {
@@ -56,6 +59,7 @@ public BigDecimal getNetCost() {
 
   /**
    * Retrieves amount of units.
+   *
    * @return amount of units.
    */
   public Long getAmount() {
@@ -64,6 +68,7 @@ public Long getAmount() {
 
   /**
    * Sets the title.
+   *
    * @param title title to set.
    */
   public void setTitle(String title) {
@@ -72,6 +77,7 @@ public void setTitle(String title) {
 
   /**
    * Sets net cost per unit.
+   *
    * @param netCost net cost to set.
    */
   public void setNetCost(BigDecimal netCost) {
@@ -80,6 +86,7 @@ public void setNetCost(BigDecimal netCost) {
 
   /**
    * Sets amount of units.
+   *
    * @param amount amount to set.
    */
   public void setAmount(Long amount) {
@@ -117,9 +124,9 @@ public int hashCode() {
   @Override
   public String toString() {
     return "OrderPosition{" +
-        "title='" + title + '\'' +
-        ", netCost=" + netCost +
-        ", amount=" + amount +
-        '}';
+      "title='" + title + '\'' +
+      ", netCost=" + netCost +
+      ", amount=" + amount +
+      '}';
   }
 }