Merge pull request #216 from xdev-software/develop

Release

Author: AB-xdev

.github/dependabot.yml

@@ -21,6 +21,11 @@ updates:
     time: "00:00"
   open-pull-requests-limit: 10
   ignore:
-  - dependency-name: "org.eclipse.jetty:jetty-maven-plugin"
-    # Version 11+ requires jakarta.* instead of javax.* (see https://www.eclipse.org/jetty/download.php#what-jetty-version)
-    versions: ">=11.0.0"
+  - dependency-name: "org.yaml:snakeyaml"
+    # Version 2+ requires Spring Boot 3
+    versions: ">=2.0.0"
+  - dependency-name: "org.springframework.boot:*"
+    # Version 3+ requires Vaadin 24
+    versions: ">=3.0.0"
+  - dependency-name: "com.vaadin:*"
+    versions: ">=24.0.0"

.github/workflows/checkBuild.yml

@@ -59,5 +59,5 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: demo-files-java-${{ matrix.java }}
-        path: ${{ env.DEMO_MAVEN_MODULE }}/target/${{ env.DEMO_MAVEN_MODULE }}.war
+        path: ${{ env.DEMO_MAVEN_MODULE }}/target/${{ env.DEMO_MAVEN_MODULE }}.jar
         if-no-files-found: error

.github/workflows/release.yml

@@ -8,6 +8,10 @@ env:
   PRIMARY_MAVEN_MODULE: ${{ github.event.repository.name }}
   DEMO_MAVEN_MODULE: ${{ github.event.repository.name }}-demo
 
+permissions:
+  contents: write
+  pull-requests: write
+
 jobs:
   check_code: # Validates the code (see develop.yml)
     runs-on: ubuntu-latest
@@ -84,9 +88,7 @@ jobs:
     
     - name: Create Release
       id: create_release
-      uses: actions/create-release@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      uses: shogo82148/actions-create-release@v1
       with:
         tag_name: v${{ steps.version.outputs.release }}
         release_name: v${{ steps.version.outputs.release }}
@@ -104,8 +106,6 @@ jobs:
              <version>${{ steps.version.outputs.release }}</version>
           </dependency>
           ```
-        draft: false
-        prerelease: false
 
   publish_central: # Publish the code to central
     runs-on: ubuntu-latest
@@ -137,51 +137,6 @@ jobs:
         MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_TOKEN }}
         MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
       working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
-  
-  build_directory: # Build a ZIP that can be uploaded to Vaadin Directory
-    runs-on: ubuntu-latest
-    needs: [prepare_release]
-    steps:
-    - uses: actions/checkout@v3
-    
-    - name: Init Git and pull
-      run: |
-        git config --global user.email "actions@github.com"
-        git config --global user.name "GitHub Actions"
-        git pull
-    
-    - name: Set up JDK
-      uses: actions/setup-java@v3
-      with:
-        java-version: '11'
-        distribution: 'temurin'
-      
-    - name: Build for Vaadin Directory
-      run: mvn -B install -Pdirectory
-      working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
-      
-    - name: Upload asset
-      uses: actions/upload-artifact@v3
-      with:
-        name: vaadin-directory-files
-        path: ${{ env.PRIMARY_MAVEN_MODULE }}/target/${{ env.PRIMARY_MAVEN_MODULE }}-*.zip
-        if-no-files-found: error
-
-    - name: Get version
-      id: version
-      run: |
-       echo "release=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)" >> $GITHUB_OUTPUT
-      working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
-
-    - name: Upload Release Asset
-      uses: actions/upload-release-asset@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        upload_url: ${{ needs.prepare_release.outputs.upload_url }}
-        asset_path: ${{ env.PRIMARY_MAVEN_MODULE }}/target/${{ env.PRIMARY_MAVEN_MODULE }}-${{ steps.version.outputs.release }}.zip
-        asset_name: ${{ env.PRIMARY_MAVEN_MODULE }}-${{ steps.version.outputs.release }}.zip
-        asset_content_type: application/zip
 
   publish-pages:
     name: Publish dependencies and licenses to github pages
@@ -240,7 +195,7 @@ jobs:
 
   after_release:
     runs-on: ubuntu-latest
-    needs: [publish_central, build_directory]
+    needs: [publish_central]
     steps:
     - uses: actions/checkout@v3
 
@@ -270,7 +225,6 @@ jobs:
     - name: pull-request
       uses: repo-sync/pull-request@v2
       with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
         destination_branch: "develop"
         pr_title: "Sync back"
         pr_body: "An automated PR to sync changes back"

.idea/checkstyle-idea.xml

@@ -0,0 +1,16 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Demo" type="Application" factoryName="Application">
+    <option name="MAIN_CLASS_NAME" value="software.xdev.vaadin.Application" />
+    <module name="vaadin-date-range-picker-demo" />
+    <option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
+    <extension name="coverage">
+      <pattern>
+        <option name="PATTERN" value="software.xdev.vaadin.*" />
+        <option name="ENABLED" value="true" />
+      </pattern>
+    </extension>
+    <method v="2">
+      <option name="Make" enabled="true" />
+    </method>
+  </configuration>
+</component>

.idea/codeStyles/Project.xml

@@ -1,3 +1,7 @@
+## 3.0.3
+* Renamed ``defaultModel`` to ``initialModel``
+* Updated dependencies
+
 ## 3.0.2
 * Updated dependencies
   * Vaadin 23.3

.run/Run Demo.run.xml

@@ -0,0 +1,60 @@
+## Contributing
+
+We would absolutely love to get the community involved, and we welcome any form of contributions – comments and questions on different communication channels, issues and pull request in the repositories, and anything that you build and share using our components.
+
+### Get in touch with the team
+
+Twitter: https://twitter.com/xdevsoftware 
+<br/>
+Mail: opensource@xdev-software.de
+
+### Some ways to help:
+
+- **Report bugs**: File issues on GitHub.
+- **Send pull requests**: If you want to contribute code, check out the development instructions below.
+
+We encourage you to read the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing) also.
+
+## Developing
+
+### Software Requirements
+You should have the following things installed:
+* Git
+* Java 11 or 17 - should be as unmodified as possible (Recommended: [Eclipse Adoptium](https://adoptium.net/temurin/releases/))
+* Maven
+
+### Recommended setup
+* Install ``IntelliJ`` (Community Edition is sufficient)
+  * Install the following plugins:
+    * [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) - Provides save actions, like running the formatter or adding ``final`` to fields
+    * [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis
+    * [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis
+  * Import the project
+  * Ensure that everything is encoded in ``UTF-8``
+  * Ensure that the JDK/Java-Version is correct
+  * To enable AUTOMATIC reloading/restarting while developing and running the app do this (further information in "
+    SpringBoot-Devtools" section below; [Source](https://stackoverflow.com/q/33349456)):
+    * ``Settings > Build, Execution, Deployment > Compiler``:<br/>
+      Enable [``Build project automatically``](https://www.jetbrains.com/help/idea/compiling-applications.html#auto-build)
+    * ``Settings > Advanced Settings``:<br/>
+    Enable [``Allow auto-make to start even if developed application is currently running``](https://www.jetbrains.com/help/idea/advanced-settings.html#advanced_compiler)
+  * To launch the Demo execute the predefined (launch) configuration ``Run Demo``
+
+#### [SpringBoot-Developer-Tools](https://docs.spring.io/spring-boot/docs/current/reference/html/using.html#using.devtools) 
+... should automatically be enabled.<br/>
+If you are changing a file and build the project, parts of the app get  restarted.<br/>
+Bigger changes may require a complete restart.
+  * [Vaadin automatically reloads the UI on each restart](https://vaadin.com/docs/latest/configuration/live-reload/spring-boot).<br/>
+  You can control this behavior with the ``vaadin.devmode.liveReload.enabled`` property (default: ``true``).
+
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-date-range-picker/release.yml?branch=master)](https://github.com/xdev-software/vaadin-date-range-picker/actions/workflows/release.yml)
+
+Before releasing:
+* Consider doing a [test-deployment](https://github.com/xdev-software/vaadin-date-range-picker/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Check the [changelog](CHANGELOG.md)
+
+If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes
+
+When the release is finished do the following:
+* Merge the auto-generated PR (with the incremented version number) back into the ``develop``
+* Ensure that [Vaadin Directory](https://vaadin.com/directory) syncs the update and maybe update the component / version there

CHANGELOG.md

@@ -23,9 +23,7 @@ A Vaadin Flow DateRangePicker implementation
 
 ## Run the Demo
 * Checkout the repo
-* Run ``mvn clean install``
-* Navigate into ``vaadin-date-range-picker-demo`` 
-* Run ``mvn jetty:run``
+* Run ``mvn install && mvn -f vaadin-date-range-picker-demo spring-boot:run``
 * Open http://localhost:8080
 
 
@@ -35,38 +33,11 @@ A Vaadin Flow DateRangePicker implementation
   ![demo](assets/demo.gif)
 </details>
 
+## Support
+If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
+
+## Contributing
+See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
 ## Dependencies and Licenses
 View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/vaadin-date-range-picker/dependencies/)
-
-
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-date-range-picker/release.yml?branch=master)](https://github.com/xdev-software/vaadin-date-range-picker/actions/workflows/release.yml)
-
-Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/vaadin-date-range-picker/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
-* Check the [changelog](CHANGELOG.md)
-
-If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes
-
-When the release is finished do the following:
-* Merge the auto-generated PR (with the incremented version number) back into the ``develop``
-* Upload the generated release asset zip into the [Vaadin Directory](https://vaadin.com/directory) and update the component there
-
-
-## Developing
-
-### Software Requirements
-You should have the following things installed:
-* Git
-* Java 11 - should be as unmodified as possible (Recommended: [Eclipse Adoptium](https://adoptium.net/temurin/releases/))
-* Maven
-
-### Recommended setup
-* Install ``IntelliJ`` (Community Edition is sufficient)
-  * Install the following plugins:
-    * [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) - Provides save actions, like running the formatter or adding ``final`` to fields
-    * [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis
-    * [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis
-  * Import the project
-  * Ensure that everything is encoded in ``UTF-8``
-  * Ensure that the JDK/Java-Version is correct

CONTRIBUTING.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/vaadin-addon-template/security/advisories/new).
+Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/vaadin-date-range-picker/security/advisories/new).