diff options
| author | Julien Eluard <[email protected]> | 2012-02-02 22:46:03 -0200 |
|---|---|---|
| committer | Julien Eluard <[email protected]> | 2012-02-02 22:46:03 -0200 |
| commit | 90afc789bd65e48871b8782c7bbf1f5e3c76fbed (patch) | |
| tree | b54899206e2d37fae93ad45eee83c2830218c097 | |
| parent | df34d8ddd3e94886b929dbb9355381cbb1d267e3 (diff) | |
Update README.md
| -rwxr-xr-x | README.md | 65 |
1 files changed, 65 insertions, 0 deletions
@@ -112,6 +112,20 @@ the maven-enforcer-plugin and then configure the maven-enforcer-plugin to run th Once you have configured your project, maven-enforcer will be able to throw a build error if current version is not backward compatible with last released one. +You can force strict checking (i.e. compatibility type must exactly match specified one): + +```xml +<configuration> + <rules> + <requireBackwardCompatibility implementation="org.semver.enforcer.RequireBackwardCompatibility"> + ... + <strictChecking>true</strictChecking> + ... + </requireBackwardCompatibility> + </rules> +</configuration> +``` + ## Checking a project's version In order to check your project's version, you must add the enforcer rule as a dependency to @@ -166,6 +180,57 @@ the maven-enforcer-plugin and then configure the maven-enforcer-plugin to run th Once you have configured your project, maven-enforcer will be able to throw a build error if current version follows semantic versioning principles. +## Dumping details + +Dump details of detected changes: + +```xml +<configuration> + <rules> + <require...> + ... + <dumpDetails>true</dumpDetails> + ... + </require...> + </rules> +</configuration> +``` + +## Checking against a wekk known version + +You can force check with a well known version: + +```xml +<configuration> + <rules> + <require...> + ... + <previousVersion>1.0.0</previousVersion> + ... + </require...> + </rules> +</configuration> +``` + +## Filtering + +Both rules allow to filter classes/packages: + +```xml +<require...> + ... + <includes> + <include>org.project.MyClass</include> + <include>org.project.internal</include> + </includes> + <excludes> + <exclude>org.project.MyClass</exclude> + <exclude>org.project.internal</exclude> + </excludes> + ... +</require...> +``` + # API overview Semantic Versioning also provides an API for programmatically validating your project's version number. |