Skip to content

Commit 487c472

Browse files
AB-xdevAB-xdev
authored
Merge pull request #296 from xdev-software/develop
Release
2 parents 9fe96c4 + 6881a86 commit 487c472

31 files changed

+497
-526
lines changed

‎.config/checkstyle/checkstyle.xml

+141
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
3+
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
4+
<module name="Checker">
5+
<!-- Only check code -->
6+
<property name="fileExtensions" value="java"/>
7+
<property name="severity" value="error"/>
8+
9+
<property name="tabWidth" value="4"/>
10+
11+
<module name="SuppressionFilter">
12+
<property name="file" value=".config/checkstyle/suppressions.xml"/>
13+
</module>
14+
15+
<module name="FileLength"/>
16+
<module name="LineLength">
17+
<property name="max" value="120"/>
18+
<property name="fileExtensions" value="java"/>
19+
<!-- Ignore default + links in comments -->
20+
<property name="ignorePattern" value="(^(package|import))|(^\s*(\/\/|\*) .*https?.*$)"/>
21+
</module>
22+
<module name="NewlineAtEndOfFile"/>
23+
24+
<module name="RegexpSingleline">
25+
<!-- Ignore inside block comments (*) -->
26+
<property name="format" value="[^\s\*][\s]{1,}$"/>
27+
<property name="minimum" value="0"/>
28+
<property name="maximum" value="0"/>
29+
<property name="message" value="Line has trailing whitespaces"/>
30+
</module>
31+
32+
<!-- Generated code -->
33+
<module name="SuppressionSingleFilter">
34+
<property name="checks" value="."/>
35+
<property name="files" value="[\\/](src)?gen[\\/].*\.java$"/>
36+
</module>
37+
<module name="SuppressionSingleFilter">
38+
<property name="checks" value="."/>
39+
<property name="files" value="[\\/]src[\\/]gen(erated)?[\\/].*\.java$"/>
40+
</module>
41+
<!-- Test code -->
42+
<module name="SuppressionSingleFilter">
43+
<property name="checks" value="MagicNumberCheck"/>
44+
<property name="files" value="[\\/]test[\\/].*\.java$"/>
45+
</module>
46+
<module name="SuppressWarningsFilter"/>
47+
48+
<module name="TreeWalker">
49+
<!-- Checks - sorted alphabetically -->
50+
<module name="ArrayTypeStyle"/>
51+
<module name="AvoidStarImport"/>
52+
<module name="ConstantName"/>
53+
<module name="DefaultComesLast"/>
54+
<module name="EmptyBlock"/>
55+
<module name="EmptyCatchBlock"/>
56+
<module name="EmptyForInitializerPad"/>
57+
<module name="EmptyForIteratorPad"/>
58+
<module name="EmptyStatement"/>
59+
<module name="EqualsHashCode"/>
60+
<module name="ExplicitInitialization">
61+
<property name="severity" value="info"/>
62+
</module>
63+
<module name="FinalClass"/>
64+
<module name="FinalParameters"/>
65+
<module name="GenericWhitespace"/>
66+
<module name="HideUtilityClassConstructor"/>
67+
<module name="IllegalImport"/>
68+
<module name="InterfaceIsType"/>
69+
<module name="JavadocStyle">
70+
<property name="checkFirstSentence" value="false"/>
71+
</module>
72+
<module name="LeftCurly">
73+
<!-- Default minus Lambda -->
74+
<property name="tokens" value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF, INTERFACE_DEF, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF, OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF"/>
75+
<property name="option" value="nl"/>
76+
</module>
77+
<module name="LocalFinalVariableName"/>
78+
<module name="LocalVariableName"/>
79+
<module name="MagicNumber">
80+
<property name="ignoreAnnotation" value="true"/>
81+
<property name="ignoreFieldDeclaration" value="true"/>
82+
<property name="ignoreHashCodeMethod" value="true"/>
83+
<!-- Defaults + other common constant values (e.g. time) -->
84+
<property name="ignoreNumbers" value="-1, 0, 1, 2, 3, 4, 5, 10, 12, 24, 31, 60, 100, 1000"/>
85+
</module>
86+
<module name="MemberName"/>
87+
<module name="MethodLength"/>
88+
<module name="MethodName"/>
89+
<module name="MethodParamPad"/>
90+
<module name="MissingDeprecated"/>
91+
<module name="MissingOverride"/>
92+
<module name="MissingSwitchDefault"/>
93+
<module name="ModifierOrder"/>
94+
<module name="NeedBraces"/>
95+
<module name="NoClone"/>
96+
<module name="NoFinalizer"/>
97+
<module name="NonEmptyAtclauseDescription"/>
98+
<module name="NoWhitespaceAfter"/>
99+
<module name="NoWhitespaceBefore"/>
100+
<module name="OneStatementPerLine"/>
101+
<module name="OneTopLevelClass"/>
102+
<module name="OperatorWrap"/>
103+
<module name="OuterTypeNumber"/>
104+
<module name="PackageName"/>
105+
<module name="ParameterName"/>
106+
<module name="ParenPad"/>
107+
<module name="RedundantImport"/>
108+
<module name="RequireThis"/>
109+
<module name="RightCurly">
110+
<property name="option" value="alone"/>
111+
</module>
112+
<module name="SimplifyBooleanExpression"/>
113+
<module name="StaticVariableName"/>
114+
<module name="StringLiteralEquality"/>
115+
<module name="SuppressWarningsHolder"/>
116+
<module name="TodoComment">
117+
<property name="severity" value="info"/>
118+
</module>
119+
<module name="TypecastParenPad"/>
120+
<module name="TypeName"/>
121+
<module name="UnusedImports"/>
122+
<module name="UpperEll"/>
123+
<module name="VisibilityModifier">
124+
<property name="packageAllowed" value="true"/>
125+
<property name="protectedAllowed" value="true"/>
126+
</module>
127+
<module name="WhitespaceAfter">
128+
<property name="tokens" value="COMMA,SEMI"/>
129+
</module>
130+
<module name="WhitespaceAround">
131+
<property name="tokens"
132+
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"/>
133+
</module>
134+
135+
<!-- Filter -->
136+
<module name="SuppressionCommentFilter">
137+
<property name="offCommentFormat" value="\s*CHECKSTYLE:OFF\s*[^\s]{1,}"/>
138+
<property name="onCommentFormat" value="\s*CHECKSTYLE:ON"/>
139+
</module>
140+
</module>
141+
</module>

‎.config/checkstyle/suppressions.xml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE suppressions PUBLIC
3+
"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
4+
"https://checkstyle.org/dtds/suppressions_1_2.dtd">
5+
<suppressions>
6+
</suppressions>

‎.github/workflows/checkBuild.yml

+30-3
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,16 @@ on:
66
branches: [ develop ]
77
paths-ignore:
88
- '**.md'
9+
- '.config/**'
10+
- '.idea/**'
11+
- 'assets/**'
912
pull_request:
1013
branches: [ develop ]
1114
paths-ignore:
1215
- '**.md'
16+
- '.config/**'
17+
- '.idea/**'
18+
- 'assets/**'
1319

1420
env:
1521
PRIMARY_MAVEN_MODULE: ${{ github.event.repository.name }}
@@ -21,14 +27,14 @@ jobs:
2127

2228
strategy:
2329
matrix:
24-
java: [17]
30+
java: [17, 21]
2531
distribution: [temurin]
2632

2733
steps:
2834
- uses: actions/checkout@v4
2935

3036
- name: Set up JDK
31-
uses: actions/setup-java@v3
37+
uses: actions/setup-java@v4
3238
with:
3339
distribution: ${{ matrix.distribution }}
3440
java-version: ${{ matrix.java }}
@@ -56,8 +62,29 @@ jobs:
5662
fi
5763
5864
- name: Upload demo files
59-
uses: actions/upload-artifact@v3
65+
uses: actions/upload-artifact@v4
6066
with:
6167
name: demo-files-java-${{ matrix.java }}
6268
path: ${{ env.DEMO_MAVEN_MODULE }}/target/${{ env.DEMO_MAVEN_MODULE }}.jar
6369
if-no-files-found: error
70+
71+
code-style:
72+
runs-on: ubuntu-latest
73+
74+
strategy:
75+
matrix:
76+
java: [17]
77+
distribution: [temurin]
78+
79+
steps:
80+
- uses: actions/checkout@v4
81+
82+
- name: Set up JDK
83+
uses: actions/setup-java@v4
84+
with:
85+
distribution: ${{ matrix.distribution }}
86+
java-version: ${{ matrix.java }}
87+
cache: 'maven'
88+
89+
- name: Run Checkstyle
90+
run: mvn -B checkstyle:check -P checkstyle -T2C

‎.github/workflows/release.yml

+19-13
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
- uses: actions/checkout@v4
2020

2121
- name: Set up JDK
22-
uses: actions/setup-java@v3
22+
uses: actions/setup-java@v4
2323
with:
2424
java-version: '17'
2525
distribution: 'temurin'
@@ -101,12 +101,15 @@ jobs:
101101
Add the following lines to your pom:
102102
```XML
103103
<dependency>
104-
<groupId>com.xdev-software</groupId>
104+
<groupId>software.xdev</groupId>
105105
<artifactId>${{ env.PRIMARY_MAVEN_MODULE }}</artifactId>
106106
<version>${{ steps.version.outputs.release }}</version>
107107
</dependency>
108108
```
109109
110+
### Additional notes
111+
* [Spring-Boot] You may have to include ``software/xdev`` inside [``vaadin.whitelisted-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)
112+
110113
publish_central: # Publish the code to central
111114
runs-on: ubuntu-latest
112115
needs: [prepare_release]
@@ -120,7 +123,7 @@ jobs:
120123
git pull
121124
122125
- name: Set up JDK Apache Maven Central
123-
uses: actions/setup-java@v3
126+
uses: actions/setup-java@v4
124127
with: # running setup-java again overwrites the settings.xml
125128
java-version: '17'
126129
distribution: 'temurin'
@@ -133,8 +136,8 @@ jobs:
133136
- name: Publish to Apache Maven Central
134137
run: mvn -B deploy -Possrh
135138
env:
136-
MAVEN_CENTRAL_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
137-
MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_TOKEN }}
139+
MAVEN_CENTRAL_USERNAME: ${{ secrets.S01_OSS_SONATYPE_MAVEN_USERNAME }}
140+
MAVEN_CENTRAL_TOKEN: ${{ secrets.S01_OSS_SONATYPE_MAVEN_TOKEN }}
138141
MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
139142
working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
140143

@@ -152,7 +155,7 @@ jobs:
152155
git pull
153156
154157
- name: Setup - Java
155-
uses: actions/setup-java@v3
158+
uses: actions/setup-java@v4
156159
with:
157160
java-version: '17'
158161
distribution: 'temurin'
@@ -163,7 +166,7 @@ jobs:
163166
working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
164167

165168
- name: Upload licenses - Upload Artifact
166-
uses: actions/upload-artifact@v3
169+
uses: actions/upload-artifact@v4
167170
with:
168171
name: dependencies-licenses
169172
path: ${{ env.PRIMARY_MAVEN_MODULE }}/target/site
@@ -223,9 +226,12 @@ jobs:
223226
git push origin
224227
225228
- name: pull-request
226-
uses: repo-sync/pull-request@v2
227-
with:
228-
destination_branch: "develop"
229-
pr_title: "Sync back"
230-
pr_body: "An automated PR to sync changes back"
231-
229+
env:
230+
GH_TOKEN: ${{ github.token }}
231+
run: |
232+
gh_pr_up() {
233+
gh pr create "$@" || gh pr edit "$@"
234+
}
235+
gh_pr_up -B "develop" \
236+
--title "Sync back" \
237+
--body "An automated PR to sync changes back"

‎.github/workflows/sonar.yml

+7-5
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@ on:
66
branches: [ develop ]
77
paths-ignore:
88
- '**.md'
9+
- '.config/**'
10+
- '.idea/**'
911
- 'assets/**'
10-
- 'config/**'
1112
pull_request:
1213
types: [opened, synchronize, reopened]
1314
paths-ignore:
1415
- '**.md'
16+
- '.config/**'
17+
- '.idea/**'
1518
- 'assets/**'
16-
- 'config/**'
1719

1820
env:
1921
SONARCLOUD_ORG: ${{ github.event.organization.login }}
@@ -31,20 +33,20 @@ jobs:
3133
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
3234

3335
- name: Set up JDK
34-
uses: actions/setup-java@v3
36+
uses: actions/setup-java@v4
3537
with:
3638
distribution: 'temurin'
3739
java-version: 17
3840

3941
- name: Cache SonarCloud packages
40-
uses: actions/cache@v3
42+
uses: actions/cache@v4
4143
with:
4244
path: ~/.sonar/cache
4345
key: ${{ runner.os }}-sonar
4446
restore-keys: ${{ runner.os }}-sonar
4547

4648
- name: Cache Maven packages
47-
uses: actions/cache@v3
49+
uses: actions/cache@v4
4850
with:
4951
path: ~/.m2
5052
key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}

‎.github/workflows/test-deploy.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
- uses: actions/checkout@v4
1414

1515
- name: Set up JDK OSSRH
16-
uses: actions/setup-java@v3
16+
uses: actions/setup-java@v4
1717
with: # running setup-java again overwrites the settings.xml
1818
distribution: 'temurin'
1919
java-version: '17'
@@ -27,6 +27,6 @@ jobs:
2727
run: mvn -B deploy -Possrh
2828
working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
2929
env:
30-
MAVEN_CENTRAL_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
31-
MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_TOKEN }}
30+
MAVEN_CENTRAL_USERNAME: ${{ secrets.S01_OSS_SONATYPE_MAVEN_USERNAME }}
31+
MAVEN_CENTRAL_TOKEN: ${{ secrets.S01_OSS_SONATYPE_MAVEN_TOKEN }}
3232
MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}

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

+9-8
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,13 @@ jobs:
8181
echo "abort=0" >> $GITHUB_OUTPUT
8282
8383
- name: pull-request
84-
uses: repo-sync/pull-request@v2
8584
if: steps.main.outputs.abort == 0
86-
with:
87-
github_token: ${{ secrets.GITHUB_TOKEN }}
88-
source_branch: ${{ env.UPDATE_BRANCH }}
89-
destination_branch: ${{ steps.main.outputs.current_branch }}
90-
pr_title: "Update from template"
91-
pr_body: "An automated PR to sync changes from the template into this repo"
92-
85+
env:
86+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
87+
run: |
88+
gh_pr_up() {
89+
gh pr create -H "${{ env.UPDATE_BRANCH }}" "$@" || (git checkout "${{ env.UPDATE_BRANCH }}" && gh pr edit "$@")
90+
}
91+
gh_pr_up -B "${{ steps.main.outputs.current_branch }}" \
92+
--title "Update from template" \
93+
--body "An automated PR to sync changes from the template into this repo"

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ vite.generated.ts
8282
/*/frontend/generated/
8383
/*/frontend/index.html
8484
/*/src/main/dev-bundle/
85+
/*/src/main/bundles/
86+
*.lock
8587

8688
#custom
8789
.flattened-pom.xml

0 commit comments

Comments
 (0)