Merge pull request #390 from xdev-software/develop

Release

.config/checkstyle/checkstyle.xml

@@ -16,7 +16,7 @@
 	<module name="LineLength">
 		<property name="max" value="120"/>
 		<property name="fileExtensions" value="java"/>
-		<!-- Ignore default + links in comments -->
+		<!-- Ignore default + links -->
 		<property name="ignorePattern" value="(^(package|import))|(^\s*(\/\/|\*) .*https?.*$)"/>
 	</module>
 	<module name="NewlineAtEndOfFile"/>
@@ -30,10 +30,6 @@
 	</module>
 
 	<!-- Generated code -->
-	<module name="SuppressionSingleFilter">
-		<property name="checks" value="."/>
-		<property name="files" value="[\\/](src)?gen[\\/].*\.java$"/>
-	</module>
 	<module name="SuppressionSingleFilter">
 		<property name="checks" value="."/>
 		<property name="files" value="[\\/]src[\\/]gen(erated)?[\\/].*\.java$"/>
@@ -43,7 +39,15 @@
 		<property name="checks" value="MagicNumberCheck"/>
 		<property name="files" value="[\\/]test[\\/].*\.java$"/>
 	</module>
+
+	<!-- Suppressions -->
 	<module name="SuppressWarningsFilter"/>
+	<!-- https://github.com/checkstyle/checkstyle/issues/7287 -->
+	<module name="SuppressWithPlainTextCommentFilter">
+		<property name="offCommentFormat" value="// CHECKSTYLE\:OFF ([\w\|]+)"/>
+		<property name="onCommentFormat" value="// CHECKSTYLE\:ON ([\w\|]+)"/>
+		<property name="checkFormat" value="$1"/>
+	</module>
 
 	<module name="TreeWalker">
 		<!-- Checks - sorted alphabetically -->
@@ -131,11 +135,5 @@
 			<property name="tokens"
 					  value="ASSIGN,BAND,BAND_ASSIGN,BOR,BOR_ASSIGN,BSR,BSR_ASSIGN,BXOR,BXOR_ASSIGN,COLON,DIV,DIV_ASSIGN,EQUAL,GE,GT,LAND,LCURLY,LE,LOR,LT,MINUS,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS,PLUS_ASSIGN,QUESTION,RCURLY,SL,SLIST,SL_ASSIGN,SR,SR_ASSIGN,STAR,STAR_ASSIGN,TYPE_EXTENSION_AND"/>
 		</module>
-
-		<!-- Filter -->
-		<module name="SuppressionCommentFilter">
-			<property name="offCommentFormat" value="\s*CHECKSTYLE:OFF\s*[^\s]{1,}"/>
-			<property name="onCommentFormat" value="\s*CHECKSTYLE:ON"/>
-		</module>
 	</module>
 </module>

.gitattributes

@@ -1,2 +1,9 @@
 # Auto detect text files and perform LF normalization
 * text=auto
+
+# Force sh files to have LF
+*.sh text eol=lf
+
+# Force MVN Wrapper Linux files LF
+mvnw text eol=lf
+.mvn/wrapper/maven-wrapper.properties text eol=lf

.github/.lycheeignore

@@ -0,0 +1,3 @@
+# Ignorefile for broken link check
+localhost
+mvnrepository.com

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,68 @@
+name: 🐞 Bug
+description: Create a bug report for something that is broken
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for reporting a bug.
+
+        Please fill in as much information as possible about your bug so that we don't have to play "information ping-pong" and can help you immediately.
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: "Checklist"
+      options:
+        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/vaadin-maps-leaflet-flow/releases/latest)"
+          required: true
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/vaadin-maps-leaflet-flow/issues) or [closed](https://github.com/xdev-software/vaadin-maps-leaflet-flow/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+          required: true
+        - label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
+          required: true
+        - label: "This issue contains only one bug."
+          required: true
+
+  - type: input
+    id: app-version
+    attributes:
+      label: Affected version
+      description: "In which version did you encounter the bug?"
+      placeholder: "x.x.x"
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to reproduce the bug
+      description: |
+        What did you do for the bug to show up?
+
+        If you can't cause the bug to show up again reliably (and hence don't have a proper set of steps to give us), please still try to give as many details as possible on how you think you encountered the bug.
+      placeholder: |
+        1. Use '...'
+        2. Do '...'
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: |
+        Tell us what you expect to happen.
+
+  - type: textarea
+    id: actual-behavior
+    attributes:
+      label: Actual behavior
+      description: |
+        Tell us what happens with the steps given above.
+
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: Additional information
+      description: |
+        Any other relevant information you'd like to include

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+contact_links:
+  - name: 💬 Contact support
+    url: https://xdev.software/en/services/support
+    about: "If you need support as soon as possible or/and you can't wait for any pull request"

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -0,0 +1,32 @@
+name: ✨ Feature/Enhancement
+description: Suggest a new feature or enhancement
+labels: [enhancement]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for suggesting a new feature/enhancement.
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: "Checklist"
+      options:
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/vaadin-maps-leaflet-flow/issues) or [closed](https://github.com/xdev-software/vaadin-maps-leaflet-flow/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+          required: true
+        - label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise."
+          required: true
+        - label: "This issue contains only one feature request/enhancement."
+          required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: Additional information

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,31 @@
+name: ❓ Question
+description: Ask a question
+labels: [question]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this form!
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: "Checklist"
+      options:
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/vaadin-maps-leaflet-flow/issues) or [closed](https://github.com/xdev-software/vaadin-maps-leaflet-flow/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+          required: true
+        - label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise."
+          required: true
+
+  - type: textarea
+    id: what-is-the-question
+    attributes:
+      label: What is/are your question(s)?
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: Additional information
+      description: "Any other information you'd like to include - for instance logs, screenshots, etc."

.github/labels.yml

@@ -0,0 +1,38 @@
+# Default
+## Required for template
+- name: bug
+  description: "Something isn't working"
+  color: 'd73a4a'
+- name: enhancement
+  description: New feature or request
+  color: '#a2eeef'
+- name: question
+  description: Information is requested
+  color: '#d876e3'
+## Others
+- name: duplicate
+  description: This already exists
+  color: '#cfd3d7'
+- name: good first issue
+  description: Good for newcomers
+  color: '#7057ff'
+- name: help wanted
+  description: Extra attention is needed
+  color: '#008672'
+- name: invalid
+  description: "This doesn't seem right"
+  color: '#e4e669'
+# Custom
+- name: automated
+  description: Created by an automation
+  color: '#000000'
+- name: "can't reproduce"
+  color: '#e95f2c'
+- name: customer-requested
+  description: Was requested by a customer of us
+  color: '#068374'
+- name: stale
+  color: '#ededed'
+- name: waiting-for-response
+  description: If no response is received after a certain time the issue will be closed
+  color: '#202020'

.github/workflows/broken-links.yml

@@ -0,0 +1,43 @@
+name: Broken links
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "23 23 * * 0"
+
+permissions:
+  issues: write
+
+jobs:
+  link-checker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - run: mv .github/.lycheeignore .lycheeignore
+
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@v1
+
+      - name: Find already existing issue
+        id: find-issue
+        run: |
+          echo "number=$(gh issue list -l 'bug' -l 'automated' -L 1 -S 'in:title \"Link Checker Report\"' -s 'open' --json 'number' --jq '.[].number')" >> $GITHUB_OUTPUT
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - name: Close issue if everything is fine
+        if: env.lychee_exit_code == 0 && steps.find-issue.outputs.number != ''
+        run: gh issue close -r 'not planned' ${{ steps.find-issue.outputs.number }}
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - name: Create Issue From File
+        if: env.lychee_exit_code != 0
+        uses: peter-evans/create-issue-from-file@v5
+        with:
+          issue-number: ${{ steps.find-issue.outputs.number }}
+          title: Link Checker Report
+          content-filepath: ./lychee/out.md
+          labels: bug, automated

.github/workflows/checkBuild.yml

@@ -7,13 +7,15 @@ on:
     paths-ignore: 
       - '**.md'
       - '.config/**'
+      - '.github/**'
       - '.idea/**'
       - 'assets/**'
   pull_request:
     branches: [ develop ]
     paths-ignore: 
       - '**.md'
       - '.config/**'
+      - '.github/**'
       - '.idea/**'
       - 'assets/**'
 
@@ -41,7 +43,7 @@ jobs:
         cache: 'maven'
 
     - name: Build with Maven
-      run: mvn -B clean package -Pproduction
+      run: ./mvnw -B clean package -Pproduction
 
     - name: Check for uncommited changes
       run: |
@@ -57,7 +59,7 @@ jobs:
           echo ----------------------------------------
           echo Troubleshooting
           echo ----------------------------------------
-          echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && mvn -B clean package -Pproduction"
+          echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && ./mvnw -B clean package -Pproduction"
           exit 1
         fi
 
@@ -70,6 +72,7 @@ jobs:
 
   code-style:
     runs-on: ubuntu-latest
+    if: ${{ github.event_name != 'pull_request' || !startsWith(github.head_ref, 'renovate/') }}
 
     strategy:
       matrix:
@@ -87,4 +90,4 @@ jobs:
         cache: 'maven'
 
     - name: Run Checkstyle
-      run: mvn -B checkstyle:check -P checkstyle -T2C
+      run: ./mvnw -B checkstyle:check -P checkstyle -T2C

.github/workflows/no-response.yml

@@ -0,0 +1,26 @@
+name: No Response
+
+on:
+  workflow_dispatch:
+  issue_comment:
+    types: [created]
+  schedule:
+    - cron: '5 5 * * *'
+
+jobs:
+  noResponse:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - uses: actions/stale@v9
+        with:
+          days-before-issue-stale: 7
+          days-before-issue-close: 3
+          stale-issue-label: "stale"
+          only-labels: "waiting-for-response"
+          labels-to-remove-when-unstale: "waiting-for-response"
+          stale-issue-message: "This issue will be closed soon because there has been no further activity."
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.GITHUB_TOKEN }}