Skip to content

Commit 2f10b25

Browse files
xdev-gh-botxdev-gh-bot
committed
Merge branch 'master' into update-from-template-merged
2 parents eff887a + 9a88197 commit 2f10b25

File tree

13 files changed

+279
-38
lines changed

13 files changed

+279
-38
lines changed

‎.github/workflows/check-build.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ jobs:
4343
cache: 'maven'
4444

4545
- name: Build with Maven
46-
run: ./mvnw -B clean package
46+
run: ./mvnw -B clean package -Pproduction
4747

4848
- name: Check for uncommited changes
4949
run: |
@@ -59,7 +59,7 @@ jobs:
5959
echo ----------------------------------------
6060
echo Troubleshooting
6161
echo ----------------------------------------
62-
echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && ./mvnw -B clean package"
62+
echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && ./mvnw -B clean package -Pproduction"
6363
exit 1
6464
fi
6565

‎.github/workflows/release.yml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
cache: 'maven'
2626

2727
- name: Build with Maven
28-
run: ./mvnw -B clean package
28+
run: ./mvnw -B clean package -Pproduction
2929

3030
- name: Check for uncommited changes
3131
run: |
@@ -41,7 +41,7 @@ jobs:
4141
echo ----------------------------------------
4242
echo Troubleshooting
4343
echo ----------------------------------------
44-
echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && ./mvnw -B clean package"
44+
echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && ./mvnw -B clean package -Pproduction"
4545
exit 1
4646
fi
4747
@@ -106,6 +106,9 @@ jobs:
106106
</dependency>
107107
```
108108
109+
### Additional notes
110+
* [Spring-Boot] You may have to include ``software/xdev`` inside [``vaadin.allowed-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)
111+
109112
publish-maven:
110113
runs-on: ubuntu-latest
111114
needs: [prepare-release]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ on:
2121
env:
2222
UPDATE_BRANCH: update-from-template
2323
UPDATE_BRANCH_MERGED: update-from-template-merged
24-
REMOTE_URL: https://github.com/xdev-software/standard-maven-template.git
24+
REMOTE_URL: https://github.com/xdev-software/vaadin-addon-template.git
2525
REMOTE_BRANCH: master
2626

2727
permissions:

‎.gitignore‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,29 @@ hs_err_pid*
5757
/*/.project
5858
/*/RemoteSystemsTempFiles/
5959

60+
61+
#vaadin/node webpack/frontend stuff
62+
# Ignore Node
63+
node/
64+
65+
# The following files are generated/updated by vaadin-maven-plugin
66+
node_modules/
67+
68+
# Vaadin
69+
package.json
70+
package-lock.json
71+
webpack.generated.js
72+
webpack.config.js
73+
tsconfig.json
74+
types.d.ts
75+
vite.config.ts
76+
vite.generated.ts
77+
/*/src/main/frontend/generated/
78+
/*/src/main/frontend/index.html
79+
/*/src/main/dev-bundle/
80+
/*/src/main/bundles/
81+
*.lock
82+
6083
#custom
6184
.flattened-pom.xml
6285
.tern-project

‎.run/Run Demo.run.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<component name="ProjectRunConfigurationManager">
22
<configuration default="false" name="Run Demo" type="Application" factoryName="Application">
3-
<option name="MAIN_CLASS_NAME" value="software.xdev.Application" />
3+
<option name="MAIN_CLASS_NAME" value="software.xdev.vaadin.Application" />
44
<module name="template-placeholder-demo" />
55
<option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
66
<extension name="coverage">
77
<pattern>
8-
<option name="PATTERN" value="software.xdev.*" />
8+
<option name="PATTERN" value="software.xdev.vaadin.*" />
99
<option name="ENABLED" value="true" />
1010
</pattern>
1111
</extension>

‎CONTRIBUTING.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,20 @@ You should have the following things installed:
3232
* Import the project
3333
* Ensure that everything is encoded in ``UTF-8``
3434
* Ensure that the JDK/Java-Version is correct
35-
35+
* To enable AUTOMATIC reloading/restarting while developing and running the app do this (further information in "
36+
SpringBoot-Devtools" section below; [Source](https://stackoverflow.com/q/33349456)):
37+
* ``Settings > Build, Execution, Deployment > Compiler``:<br/>
38+
Enable [``Build project automatically``](https://www.jetbrains.com/help/idea/compiling-applications.html#auto-build)
39+
* ``Settings > Advanced Settings``:<br/>
40+
Enable [``Allow auto-make to start even if developed application is currently running``](https://www.jetbrains.com/help/idea/advanced-settings.html#advanced_compiler)
41+
* To launch the Demo execute the predefined (launch) configuration ``Run Demo``
42+
43+
#### [SpringBoot-Developer-Tools](https://docs.spring.io/spring-boot/docs/current/reference/html/using.html#using.devtools)
44+
... should automatically be enabled.<br/>
45+
If you are changing a file and build the project, parts of the app get restarted.<br/>
46+
Bigger changes may require a complete restart.
47+
* [Vaadin automatically reloads the UI on each restart](https://vaadin.com/docs/latest/configuration/live-reload/spring-boot).<br/>
48+
You can control this behavior with the ``vaadin.devmode.liveReload.enabled`` property (default: ``true``).
3649

3750
## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/release.yml?branch=master)](https://github.com/xdev-software/template-placeholder/actions/workflows/release.yml)
3851

@@ -44,6 +57,7 @@ If the ``develop`` is ready for release, create a pull request to the ``master``
4457

4558
When the release is finished do the following:
4659
* Merge the auto-generated PR (with the incremented version number) back into the ``develop``
60+
* Ensure that [Vaadin Directory](https://vaadin.com/directory) syncs the update and maybe update the component / version there
4761

4862
### Release failures
4963

‎README.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
1+
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0?logo=vaadin)](https://vaadin.com/directory/component/template-placeholder)
12
[![Latest version](https://img.shields.io/maven-central/v/software.xdev/template-placeholder?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/template-placeholder)
23
[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/check-build.yml?branch=develop)](https://github.com/xdev-software/template-placeholder/actions/workflows/check-build.yml?query=branch%3Adevelop)
34
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_template-placeholder&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_template-placeholder)
5+
![Vaadin 24+](https://img.shields.io/badge/Vaadin%20Platform/Flow-24+-00b4f0)
46

57
# template-placeholder
8+
A Vaadin Template Repo
9+
10+
![demo](assets/demo.png)
611

712

813
## Installation
914
[Installation guide for the latest release](https://github.com/xdev-software/template-placeholder/releases/latest#Installation)
1015

16+
## Run the Demo
17+
* Checkout the repo
18+
* Run ``mvn install && mvn -f template-placeholder-demo spring-boot:run``
19+
* Open http://localhost:8080
20+
21+
<details>
22+
<summary>Show example</summary>
23+
24+
![demo](assets/demo.avif)
25+
</details>
26+
1127
## Support
1228
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).
1329

‎assets/demo.avif‎

1.4 KB
Binary file not shown.

‎assets/demo.png‎

13.9 KB
Loading

‎template-placeholder-demo/pom.xml‎

Lines changed: 123 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,91 @@
2626
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
2727
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
2828

29-
<mainClass>software.xdev.Application</mainClass>
29+
<mainClass>software.xdev.vaadin.Application</mainClass>
30+
31+
<!-- Dependency-Versions -->
32+
<vaadin.version>24.4.11</vaadin.version>
33+
34+
<org.springframework.boot.version>3.3.3</org.springframework.boot.version>
3035
</properties>
3136

37+
<dependencyManagement>
38+
<dependencies>
39+
<dependency>
40+
<groupId>com.vaadin</groupId>
41+
<artifactId>vaadin-bom</artifactId>
42+
<type>pom</type>
43+
<scope>import</scope>
44+
<version>${vaadin.version}</version>
45+
</dependency>
46+
47+
<!-- Spring Boot -->
48+
<!-- This bom provides versions for ~500 dependencies -->
49+
<!-- Nearly at the end so that it doesn't accidentally overwrite other versions -->
50+
<dependency>
51+
<groupId>org.springframework.boot</groupId>
52+
<artifactId>spring-boot-dependencies</artifactId>
53+
<version>${org.springframework.boot.version}</version>
54+
<type>pom</type>
55+
<scope>import</scope>
56+
</dependency>
57+
</dependencies>
58+
</dependencyManagement>
59+
3260
<dependencies>
61+
<dependency>
62+
<groupId>com.vaadin</groupId>
63+
<artifactId>vaadin-core</artifactId>
64+
</dependency>
3365
<dependency>
3466
<groupId>software.xdev</groupId>
3567
<artifactId>template-placeholder</artifactId>
3668
<version>${project.version}</version>
3769
</dependency>
70+
71+
<!-- Spring -->
72+
<dependency>
73+
<groupId>com.vaadin</groupId>
74+
<artifactId>vaadin-spring-boot-starter</artifactId>
75+
</dependency>
76+
<!-- Temporarily excluded by Vaadin due to "security vulnerability" -->
77+
<dependency>
78+
<groupId>org.yaml</groupId>
79+
<artifactId>snakeyaml</artifactId>
80+
</dependency>
81+
<dependency>
82+
<groupId>org.springframework.boot</groupId>
83+
<artifactId>spring-boot-devtools</artifactId>
84+
<optional>true</optional>
85+
</dependency>
3886
</dependencies>
3987

4088
<build>
4189
<finalName>${project.artifactId}</finalName>
90+
91+
<pluginManagement>
92+
<plugins>
93+
<plugin>
94+
<groupId>org.springframework.boot</groupId>
95+
<artifactId>spring-boot-maven-plugin</artifactId>
96+
<version>${org.springframework.boot.version}</version>
97+
</plugin>
98+
</plugins>
99+
</pluginManagement>
42100

43101
<plugins>
102+
<plugin>
103+
<groupId>com.vaadin</groupId>
104+
<artifactId>vaadin-maven-plugin</artifactId>
105+
<version>${vaadin.version}</version>
106+
<executions>
107+
<execution>
108+
<goals>
109+
<goal>prepare-frontend</goal>
110+
</goals>
111+
</execution>
112+
</executions>
113+
</plugin>
44114
<plugin>
45115
<groupId>org.apache.maven.plugins</groupId>
46116
<artifactId>maven-compiler-plugin</artifactId>
@@ -52,34 +122,58 @@
52122
</compilerArgs>
53123
</configuration>
54124
</plugin>
55-
<plugin>
56-
<groupId>org.apache.maven.plugins</groupId>
57-
<artifactId>maven-assembly-plugin</artifactId>
58-
<version>3.7.1</version>
59-
<configuration>
60-
<archive>
61-
<manifest>
62-
<mainClass>${mainClass}</mainClass>
63-
</manifest>
64-
<manifestEntries>
65-
<Multi-Release>true</Multi-Release>
66-
</manifestEntries>
67-
</archive>
68-
<descriptorRefs>
69-
<descriptorRef>jar-with-dependencies</descriptorRef>
70-
</descriptorRefs>
71-
<appendAssemblyId>false</appendAssemblyId>
72-
</configuration>
73-
<executions>
74-
<execution>
75-
<id>make-assembly</id> <!-- this is used for inheritance merges -->
76-
<phase>package</phase> <!-- bind to the packaging phase -->
77-
<goals>
78-
<goal>single</goal>
79-
</goals>
80-
</execution>
81-
</executions>
82-
</plugin>
83125
</plugins>
84126
</build>
127+
128+
<profiles>
129+
<profile>
130+
<id>production</id>
131+
<dependencies>
132+
<!-- Exclude development dependencies from production -->
133+
<dependency>
134+
<groupId>com.vaadin</groupId>
135+
<artifactId>vaadin-core</artifactId>
136+
<exclusions>
137+
<exclusion>
138+
<groupId>com.vaadin</groupId>
139+
<artifactId>vaadin-dev</artifactId>
140+
</exclusion>
141+
</exclusions>
142+
</dependency>
143+
</dependencies>
144+
<build>
145+
<plugins>
146+
<plugin>
147+
<groupId>com.vaadin</groupId>
148+
<artifactId>vaadin-maven-plugin</artifactId>
149+
<version>${vaadin.version}</version>
150+
<executions>
151+
<execution>
152+
<goals>
153+
<goal>prepare-frontend</goal>
154+
<goal>build-frontend</goal>
155+
</goals>
156+
</execution>
157+
</executions>
158+
</plugin>
159+
<plugin>
160+
<groupId>org.springframework.boot</groupId>
161+
<artifactId>spring-boot-maven-plugin</artifactId>
162+
<configuration>
163+
<mainClass>${mainClass}</mainClass>
164+
</configuration>
165+
<executions>
166+
<execution>
167+
<id>repackage</id>
168+
<goals>
169+
<goal>repackage</goal>
170+
</goals>
171+
<phase>package</phase>
172+
</execution>
173+
</executions>
174+
</plugin>
175+
</plugins>
176+
</build>
177+
</profile>
178+
</profiles>
85179
</project>

0 commit comments

Comments
 (0)