Merge pull request #185 from xdev-software/develop

Release 3.0.1

Author: AB-xdev

.github/dependabot.yml

@@ -22,4 +22,5 @@ updates:
   open-pull-requests-limit: 10
   ignore:
   - dependency-name: "org.eclipse.jetty:jetty-maven-plugin"
-    versions: ">=10.0.0"
+    # Version 11+ requires jakarta.* instead of javax.* (see https://www.eclipse.org/jetty/download.php#what-jetty-version)
+    versions: ">=11.0.0"

.github/workflows/checkBuild.yml

@@ -11,6 +11,10 @@ on:
     paths-ignore: 
       - '**.md'
 
+env:
+  PRIMARY_MAVEN_MODULE: ${{ github.event.repository.name }}
+  DEMO_MAVEN_MODULE: ${{ github.event.repository.name }}-demo
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -55,5 +59,5 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: demo-files-java-${{ matrix.java }}
-        path: vaadin-date-range-picker-demo/target/vaadin-date-range-picker-demo.war
+        path: ${{ env.DEMO_MAVEN_MODULE }}/target/${{ env.DEMO_MAVEN_MODULE }}.war
         if-no-files-found: error

.github/workflows/release.yml

@@ -4,6 +4,10 @@ on:
   push:
     branches: [ master ]
 
+env:
+  PRIMARY_MAVEN_MODULE: ${{ github.event.repository.name }}
+  DEMO_MAVEN_MODULE: ${{ github.event.repository.name }}-demo
+
 jobs:
   check_code: # Validates the code (see develop.yml)
     runs-on: ubuntu-latest
@@ -15,14 +19,7 @@ jobs:
       with:
         java-version: '11'
         distribution: 'temurin'
-
-    - name: Cache local Maven repository
-      uses: actions/cache@v3
-      with:
-        path: ~/.m2/repository
-        key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
-        restore-keys: |
-          ${{ runner.os }}-maven-
+        cache: 'maven'
 
     - name: Build with Maven
       run: mvn -B clean package -Pproduction
@@ -63,17 +60,19 @@ jobs:
 
     - name: Un-SNAP demo
       run: mvn -B versions:set -DremoveSnapshot -DgenerateBackupPoms=false
-      working-directory: vaadin-date-range-picker-demo
+      working-directory: ${{ env.DEMO_MAVEN_MODULE }}
 
     - name: Un-SNAP 
       run: mvn -B versions:set -DremoveSnapshot -DgenerateBackupPoms=false
-      working-directory: vaadin-date-range-picker
+      working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
 
     - name: Get version
       id: version
       run: |
-       echo "::set-output name=release::$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)"
-      working-directory: vaadin-date-range-picker
+        version=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
+        echo "::set-output name=release::$version"
+        echo "::set-output name=releasenumber::${version//[!0-9]/}"
+      working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
 
     - name: Commit and Push
       run: |
@@ -93,12 +92,15 @@ jobs:
         release_name: v${{ steps.version.outputs.release }}
         commitish: master
         body: |
+          ## [Changelog](https://github.com/xdev-software/${{ env.PRIMARY_MAVEN_MODULE }}/blob/develop/CHANGELOG.md#${{ steps.version.outputs.releasenumber }})
+          See [Changelog#v${{ steps.version.outputs.release }}](https://github.com/xdev-software/${{ env.PRIMARY_MAVEN_MODULE }}/blob/develop/CHANGELOG.md#${{ steps.version.outputs.releasenumber }}) for more information.
+
           ## Installation
           Add the following lines to your pom:
           ```XML
           <dependency>
              <groupId>com.xdev-software</groupId>
-             <artifactId>vaadin-date-range-picker</artifactId>
+             <artifactId>${{ env.PRIMARY_MAVEN_MODULE }}</artifactId>
              <version>${{ steps.version.outputs.release }}</version>
           </dependency>
           ```
@@ -134,7 +136,7 @@ jobs:
         MAVEN_CENTRAL_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
         MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_TOKEN }}
         MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
-      working-directory: vaadin-date-range-picker
+      working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
 
   build_directory: # Build a ZIP that can be uploaded to Vaadin Directory
     runs-on: ubuntu-latest
@@ -156,29 +158,29 @@ jobs:
 
     - name: Build for Vaadin Directory
       run: mvn -B install -Pdirectory
-      working-directory: vaadin-date-range-picker
+      working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
 
     - name: Upload asset
       uses: actions/upload-artifact@v3
       with:
         name: vaadin-directory-files
-        path: vaadin-date-range-picker/target/vaadin-date-range-picker-*.zip
+        path: ${{ env.PRIMARY_MAVEN_MODULE }}/target/${{ env.PRIMARY_MAVEN_MODULE }}-*.zip
         if-no-files-found: error
 
     - name: Get version
       id: version
       run: |
        echo "::set-output name=release::$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)"
-      working-directory: vaadin-date-range-picker
+      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: vaadin-date-range-picker/target/vaadin-date-range-picker-${{ steps.version.outputs.release }}.zip
-        asset_name: vaadin-date-range-picker-${{ steps.version.outputs.release }}.zip
+        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:
@@ -203,19 +205,19 @@ jobs:
 
     - name: Build dependencies/licenses files
       run: mvn -B project-info-reports:dependencies
-      working-directory: vaadin-date-range-picker
+      working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
 
     - name: Upload licenses - Upload Artifact
       uses: actions/upload-artifact@v3
       with:
         name: dependencies-licenses
-        path: vaadin-date-range-picker/target/site
+        path: ${{ env.PRIMARY_MAVEN_MODULE }}/target/site
 
     - name: Generate docs/dependencies dir
       run: mkdir -p docs/dependencies
 
     - name: Move built files into docs/dependencies
-      run: mv vaadin-date-range-picker/target/site/* docs/dependencies
+      run: mv ${{ env.PRIMARY_MAVEN_MODULE }}/target/site/* docs/dependencies
 
     - name: Rename dependencies.html to index.html
       working-directory: docs/dependencies
@@ -253,11 +255,11 @@ jobs:
 
     - name: Inc Version and SNAP demo
       run: mvn -B build-helper:parse-version versions:set -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.nextIncrementalVersion} -DgenerateBackupPoms=false -DnextSnapshot=true
-      working-directory: vaadin-date-range-picker-demo
+      working-directory: ${{ env.DEMO_MAVEN_MODULE }}
 
     - name: Inc Version and SNAP 
       run: mvn -B build-helper:parse-version versions:set -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.nextIncrementalVersion} -DgenerateBackupPoms=false -DnextSnapshot=true
-      working-directory: vaadin-date-range-picker
+      working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
 
     - name: Git Commit and Push
       run: |

.github/workflows/test-deploy.yml

@@ -0,0 +1,32 @@
+name: Test Deployment
+
+on:
+  workflow_dispatch:
+
+env:
+  PRIMARY_MAVEN_MODULE: ${{ github.event.repository.name }}
+
+jobs:
+  publish_central: # Publish the code to central
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Set up JDK OSSRH
+      uses: actions/setup-java@v3
+      with: # running setup-java again overwrites the settings.xml
+        distribution: 'temurin'
+        java-version: '11'
+        server-id: ossrh
+        server-username: MAVEN_CENTRAL_USERNAME
+        server-password: MAVEN_CENTRAL_TOKEN
+        gpg-passphrase: MAVEN_GPG_PASSPHRASE
+        gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
+
+    - name: Publish to OSSRH
+      run: mvn -B deploy -Possrh
+      working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
+      env:
+        MAVEN_CENTRAL_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
+        MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_TOKEN }}
+        MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}

.github/workflows/update-from-template.yml

@@ -0,0 +1,92 @@
+name: Update from Template
+
+# This workflow keeps the repo up to date with changes from the template repo (REMOTE_URL)
+# It duplicates the REMOTE_BRANCH (into UPDATE_BRANCH) and tries to merge it into the 
+# this repos default branch (which is checked out here)
+# Note that this requires a PAT (Personal Access Token) - at best from a servicing account
+# Also note that you should have at least once merged the template repo into the current repo manually
+# otherwise a "refusing to merge unrelated histories" error might occur.
+
+on:
+  schedule:
+    - cron: '55 2 * * 1'
+  workflow_dispatch:
+
+env:
+  UPDATE_BRANCH: update-from-template
+  REMOTE_URL: https://github.com/xdev-software/vaadin-addon-template.git
+  REMOTE_BRANCH: master
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          # Required because otherwise there are always changes detected when executing diff/rev-list
+          fetch-depth: 0
+          # If no PAT is used the following error occurs on a push:
+          # refusing to allow a GitHub App to create or update workflow `.github/workflows/xxx.yml` without `workflows` permission
+          token: ${{ secrets.UPDATE_FROM_TEMPLATE_PAT }}
+      
+      - name: Init Git
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "GitHub Actions"
+
+      - name: Main workflow
+        id: main
+        run: |
+          echo "Adding remote template-repo"
+          git remote add template ${{ env.REMOTE_URL }}
+          
+          echo "Fetching remote template repo"
+          git fetch template
+          
+          echo "Deleting local branch that will contain the updates - if present"
+          git branch -D ${{ env.UPDATE_BRANCH }} || true
+          
+          echo "Checking if the remote template repo has new commits"
+          git rev-list ..template/${{ env.REMOTE_BRANCH }}
+
+          if [ $(git rev-list --count ..template/${{ env.REMOTE_BRANCH }}) -eq 0 ]; then
+            echo "There are no commits new commits on the template repo"
+            
+            echo "Deleting origin branch that contains the updates - if present"
+            git push -f origin --delete ${{ env.UPDATE_BRANCH }} || true
+            
+            echo "::set-output name=abort::1"
+            exit 0
+          fi
+          
+          echo "Found new commits on the template repo"
+          
+          echo "Creating update branch"
+          git branch ${{ env.UPDATE_BRANCH }} template/${{ env.REMOTE_BRANCH }}
+          git branch --unset-upstream ${{ env.UPDATE_BRANCH }}
+          
+          echo "Pushing update branch"
+          git push -f -u origin ${{ env.UPDATE_BRANCH }}
+          
+          echo "Getting current branch"
+          current_branch=$(git branch --show-current)
+          echo "Current branch is $current_branch"
+          echo "::set-output name=current_branch::$current_branch"
+
+          echo "::set-output name=abort::0"
+          
+      - name: pull-request
+        uses: repo-sync/pull-request@v2
+        if: steps.main.outputs.abort == 0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          source_branch: ${{ env.UPDATE_BRANCH }}
+          destination_branch: ${{ steps.main.outputs.current_branch }}
+          pr_title: "Update from template"
+          pr_body: "An automated PR to sync changes from the template into this repo"
+          

.gitignore

@@ -77,6 +77,8 @@ webpack.generated.js
 webpack.config.js
 tsconfig.json
 types.d.ts
+vite.config.ts
+vite.generated.ts
 /*/frontend/generated/
 /*/frontend/index.html
 

CHANGELOG.md

@@ -0,0 +1,13 @@
+## 3.0.1
+
+* Updated dependencies
+  * Vaadin 23.2
+
+## 3.0.0
+
+⚠️<i>This release contains breaking changes</i>
+
+* Adds support for Vaadin 23+, drops support for Vaadin 14 #155
+  <i>If you are still using Vaadin 14, use the ``2.x`` versions.</i>
+  * Requires Java 11+
+* Updated dependencies

README.md

@@ -6,7 +6,8 @@
 # vaadin-date-range-picker
 A Vaadin Flow DateRangePicker implementation
 
-![demo](demo.png)
+![demo](assets/demo.png)
+
 
 ## Installation
 [Installation guide for the latest release](https://github.com/xdev-software/vaadin-date-range-picker/releases/latest#Installation)
@@ -30,17 +31,41 @@ A Vaadin Flow DateRangePicker implementation
 <details>
   <summary>Show example</summary>
 
-  ![demo](demo.gif)
+  ![demo](assets/demo.gif)
 </details>
 
 
+## 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/workflow/status/xdev-software/vaadin-date-range-picker/Release?label=Release)](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-addon-template/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``
-* Add the release notes to the [GitHub release](https://github.com/xdev-software/vaadin-date-range-picker/releases/latest)
 * Upload the generated release asset zip into the [Vaadin Directory](https://vaadin.com/directory) and update the component there
 
-## 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/)
+
+## 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