https://github.com/webfx-project/webfx-maven-plugin
The WebFX Maven plugin
https://github.com/webfx-project/webfx-maven-plugin
Last synced: about 1 year ago
JSON representation
The WebFX Maven plugin
- Host: GitHub
- URL: https://github.com/webfx-project/webfx-maven-plugin
- Owner: webfx-project
- License: apache-2.0
- Created: 2022-03-15T14:18:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-21T11:19:18.000Z (about 2 years ago)
- Last Synced: 2025-06-01T06:52:17.639Z (about 1 year ago)
- Language: Java
- Homepage:
- Size: 32.2 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WebFX Maven Plugin
The WebFX Maven plugin allows WebFX Export command to be called from within Maven build for updating configuration files.
## How it works
The Maven project pom.xml file is updated to add the webfx-maven-plugin
and is then bound to a build phase such as pre-package.
## Building
The plugin can be built and installed locally using Maven command:
```
mvn clean install
```
## Trying out
The plugin can be run (once installed see above) using the following Maven command:
```
mvn -DprojectDirectory="/project/path" -DtargetDirectory="/target/path" dev.webfx:webfx-maven-plugin:export
```
## Configuration
Configuration consists of calling the export goal of the webfx-maven-plugin
during the pre-package phase of the Maven build lifecycle as illustrated in
the example below:
```
dev.webfx
webfx-maven-plugin
0.1.0-SNAPSHOT
dev.webfx
webfx-maven-plugin
pre-package
export
${basedir}
${project.build.directory}
true
```
The failOnError XML element can be set true to fail the build if
the return code from the export command is not 0, or set to false
to continue building.
Note: Configuration parameters can be omitted for Maven defaults
and are illustrated above for completeness.
## License
The WebFX Maven Plugin is a free, open-source software licensed under the [Apache License 2.0](LICENSE)