diff options
Diffstat (limited to 'enforcer-rule/src/site/apt/usage.apt.vm')
| -rwxr-xr-x | enforcer-rule/src/site/apt/usage.apt.vm | 138 |
1 files changed, 0 insertions, 138 deletions
diff --git a/enforcer-rule/src/site/apt/usage.apt.vm b/enforcer-rule/src/site/apt/usage.apt.vm deleted file mode 100755 index fc9c196..0000000 --- a/enforcer-rule/src/site/apt/usage.apt.vm +++ /dev/null @@ -1,138 +0,0 @@ -#* - * This software is licensed under the Apache 2 license, quoted below. - * - * Copyright 2010 Julien Eluard - * - * Licensed under the Apache License, Version 2.0 (the "License"); you may not - * use this file except in compliance with the License. You may obtain a copy of - * the License at - * - * [http://www.apache.org/licenses/LICENSE-2.0] - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations under - * the License. - *# - -Usage - - The enforcer rule offers a rule for checking project's version against a previously released artifact. - -* Basic Usage - -** Checking a project's compatibility - - In order to check your project's compatibility, you must add the enforcer rule as a dependency to - the maven-enforcer-plugin and then configure the maven-enforcer-plugin to run the rule: - ---- -<project> - ... - <build> - ... - <plugins> - ... - <plugin> - <artifactId>maven-enforcer-plugin</artifactId> - <version>1.0-beta-1</version> - ... - <dependencies> - ... - <dependency> - <groupId>${project.groupId}</groupId> - <artifactId>${project.artifactId}</artifactId> - <version>${project.version}</version> - </dependency> - ... - </dependencies> - ... - <executions> - .... - <execution> - <id>check</id> - <phase>verify</phase> - <goals> - <goal>enforce</goal> - </goals> - <configuration> - <rules> - <requireBackwardCompatibility implementation="org.semver.enforcer.RequireBackwardCompatibility"> - <compatibilityType>BACKWARD_COMPATIBLE_IMPLEMENTER</compatibilityType> - </requireBackwardCompatibility> - </rules> - </configuration> - </execution> - ... - </executions> - ... - </plugin> - ... - </plugins> - ... - </build> - ... -</project> ---- - - 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. - - Some more detailed {{{./examples/backward-compatibility.html}examples}} of the <<<requireBacwardCompatibility>>> rule. - - -** Checking a project's version - - In order to check your project's version, you must add the enforcer rule as a dependency to - the maven-enforcer-plugin and then configure the maven-enforcer-plugin to run the rule: - ---- -<project> - ... - <build> - ... - <plugins> - ... - <plugin> - <artifactId>maven-enforcer-plugin</artifactId> - <version>1.0-beta-1</version> - ... - <dependencies> - ... - <dependency> - <groupId>${project.groupId}</groupId> - <artifactId>${project.artifactId}</artifactId> - <version>${project.version}</version> - </dependency> - ... - </dependencies> - ... - <executions> - .... - <execution> - <id>check</id> - <phase>verify</phase> - <goals> - <goal>enforce</goal> - </goals> - <configuration> - <rules> - <requireSemanticVersioningConformance implementation="org.semver.enforcer.RequireSemanticVersioningConformance" /> - </rules> - </configuration> - </execution> - ... - </executions> - ... - </plugin> - ... - </plugins> - ... - </build> - ... -</project> ---- - - Once you have configured your project, maven-enforcer will be able to throw a build error if current version follows semantic versioning principles. - - Some more detailed {{{./examples/semantic-versioning-conformance.html}examples}} of the <<<requireSemanticVersioningConformance>>> rule. |