aboutsummaryrefslogtreecommitdiffstats
path: root/enforcer-rule/src/site/apt/index.apt
blob: 2887116fa28c70822fa9495d15e1ef8d4dd95a74 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
~~
~~ 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.
~~

Semantic Versioning Enforcer Rule

  The Semantic Versioning Enforcer Rule is used to check your classes against previously released classes. 
  Depending on changes your version number will be valid or not according to {{{http://semver.org}semantic versioning}} rules. 

* Rules Overview

  The Semantic Versioning Enforcer Rule has the following rules.

  * {{{./examples/semantic-versioning-conformance.html}requireSemanticVersioningConformance}} checks a project version number against an older release.

  * {{{./examples/backward-compatibility.html}requireBackwardCompatibility}} checks a project artifact against an older release.

  []