diff --git a/README.md b/README.md index a15aa1e..dbf5835 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,94 @@ +[![](https://jitpack.io/v/tegorov/allure-environment-maven-plugin.svg)](https://jitpack.io/#tegorov/allure-environment-maven-plugin) + # Allure Environment Maven Plugin -Maven plugin generating [environment.properties](https://docs.qameta.io/allure/#_environment) for Allure report +This plugin generates [environment.properties](https://docs.qameta.io/allure/#_environment) for Allure report. ![Allure Report](.github/preview_report.png) # Getting Started -TODO +* Add the JitPack repository into your `pom.xml`: +```xml + + ... + + + jitpack.io + https://jitpack.io + + + ... + +``` + +* Add the plugin: +```xml + + + + com.github.tegorov + allure-environment-maven-plugin + 0.1.0 + + + + allure-environment + + + + + + +``` # Configuration +* Add properties to the plugin configuration: ```xml -... - - - - os.name - ${os.name} - - - java.version - ${java.version} - - - junit.version - ${junit.version} - - - branch.name - ${branch.name} - - - -... + + com.github.tegorov + allure-environment-maven-plugin + ... + + + + os.name + ${os.name} + + + java.version + ${java.version} + + + junit.version + ${junit.version} + + + branch.name + ${branch.name} + + + + ``` +You can pass property value via the command line: ```shell mvn clean test -Dbranch.name=develop ``` -TODO +* `environment.properties` will be generated tо directory: `target/allure-results` + +You can change this directory: +```xml + + com.github.tegorov + allure-environment-maven-plugin + ... + + newtarger/allure-results + ... + + +```