Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raydac/mvn-finisher
Maven extension to call finishing tasks after session processing
https://github.com/raydac/mvn-finisher
maven maven-extension
Last synced: about 4 hours ago
JSON representation
Maven extension to call finishing tasks after session processing
- Host: GitHub
- URL: https://github.com/raydac/mvn-finisher
- Owner: raydac
- License: apache-2.0
- Created: 2019-09-29T13:17:02.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-16T12:00:20.000Z (over 3 years ago)
- Last Synced: 2023-07-01T07:21:44.970Z (over 1 year ago)
- Topics: maven, maven-extension
- Language: Java
- Size: 315 KB
- Stars: 6
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
- License: LICENSE
Awesome Lists containing this project
README
[](http://www.apache.org/licenses/LICENSE-2.0)
[](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
[](http://search.maven.org/#artifactdetails|com.igormaznitsa|mvn-finisher-extension|1.1.1|jar)
[](https://maven.apache.org/)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=AHWJHJFBAWGL2)
[](https://yoomoney.ru/to/41001158080699)
# Changelog
__1.1.1 (08-feb-2020)__
- added property for finish task timeout `mvn.finisher.task.timeout` in seconds, by default 120 seconds
- added property to skip execution `mvn.finisher.skip`
- added properties `mvn.finisher.log.save` and `mvn,finisher.log.folder` to save finish task log
- minor improvements and bug fixing
__1.1.0 (02-feb-2020)__
- finish tasks started as external processes
__1.0.1 (31-jan-2020)__
- added catch of JVM shutdown, its phase __finish-force__
__1.0.0 (29-sep-2019)__
- initial release
# What is it
Small [maven](https://maven.apache.org/) extesion adds three new phases into build process:
- __finish__ is called in any case if session is started (also called in JVM shutdown)
- __finish-ok__ is called only if session is built without errors (called in JVM shutdown only if session build completed)
- __finish-error__ is called only if session is built with errors (called in JVM shutdown only if session buuld completed)
- __finish-force__ is called only if JVM shutdown (press CTRL+C for instance)
It's behavior very similar to well-known `try...catch...finally` mechanism where __finish-error__ situated in the `catch` section and __finish__ situated in the `finally` section, __finish-ok__ will be called as the last ones in the body.
# How to add in a project?
Just add extension into the build extensions section
```xml
com.igormaznitsa
mvn-finisher-extension
1.1.1
```
after end of session build, the extenstion finds finishing tasks in all session projects, for instance task to print some message into console:
```xml
com.github.ekryd.echo-maven-plugin
echo-maven-plugin
1.2.0
print-echo
finish
echo
Hello World from finishing task
```
in the code snippet above, there is `print-echo` task to be executed during finish phase. If the maven build process was interrupted then `force finish` is activated.
Since 1.1.0 all finishing tasks are executed as __external__ processes through call of maven.
If defined several finishing tasks then they will be sorted in such manner:
- list of projects in order provided in maven session project list
- only projects with provided build status will be processed
- if any error in session build then execution order is:
- __finish-error__
- __finish__
- if session build is ok then execution order is:
- __finish-ok__
- __finish__
- if session canceled (for instance by CTRL+C) then execution order is:
- __finish-force__
- __finish__
__Each detected task is called separately in its own maven request so that all them will be executed even if some of them can be error.__
# Extension properties
## mvn.finisher.skip
It is a boolean property and can be either `true` or `false`. By default it is `false`. If it is `true` then execution of the extension will be skipped.
## mvn.finisher.log.save
Flag to save log of finishing tasks as text files with name pattern `artifactId_finishTaskId.log`. By default is `false`.
## mvn.finisher.log.folder
Folder to save log files. By defaul it is `mvn.finisher.logs` in the project build folder.
## mvn.finisher.task.timeout
It allows to define finish task timeout __in seconds__. By default it is 120 seconds.
# Example
Below you can see some example of extension use. The example starts some docker image and then stop and remove it in finishing tasks.
```xml
4.0.0
com.igormaznitsa
mvn-finisher-test-docker
0.0.0-SNAPSHOT
jar
com.igormaznitsa
mvn-finisher-extension
1.1.1
io.fabric8
docker-maven-plugin
0.31.0
start-docker-container
validate
start
test-container-finisher
true
docker.bintray.io/jfrog/artifactory-oss:latest
#+\s*Artifactory successfully started \([0-9.]+ seconds\)\s*#+
stop-docker-container
finish
stop
test-container-finisher
true
true
remove-docker-container
finish
remove
run
test-container-finisher
```