Skip to content

Commit e099667

Browse files
author
TheSnoozer
committed
update Plugin compatibility matrix
1 parent aede7d3 commit e099667

File tree

1 file changed

+28
-10
lines changed

1 file changed

+28
-10
lines changed

README.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -67,17 +67,29 @@ Plugin compatibility with Maven
6767
-----------------------------
6868
Even though this plugin tries to be compatible with every Maven version there are some known limitations with specific versions. Here is a list that tries to outline the current state of the art:
6969

70-
| Maven Version | Plugin Version | Notes |
71-
| --------------------------- | ---------------:|:---------------------------------------------------------------------------------------------------------------:|
72-
| Maven 3.0.X (EOL) | up to 4.0.5 | Maven 3.0.X is EOL
73-
| Maven 3.1.0 | any | git-commit-id-plugin:2.1.14, 2.1.15, 2.2.0, 2.2.1, 2.2.3 doesn't work -- requires maven version 3.1.1 |
74-
| Maven 3.3.1 | any | git-commit-id-plugin:2.1.14 doesn't work |
75-
| Maven 3.3.3 | any | git-commit-id-plugin:2.1.14 doesn't work |
76-
| Maven 3.X.X (3.0.X is EOL) | any | Any other non listed version here should work with any plugin version |
77-
70+
| Plugin Version | Minimal Required Maven version |
71+
|----------------|:----------------------------------------------------------:|
72+
| 2.1.X | Maven 2.2.1 up to v2.1.13; Maven 3.1.1 for any later 2.1.X |
73+
| 2.2.X | Maven 3.1.1 up to v2.2.3; Maven 3.0 for any later 2.2.X |
74+
| 3.0.0 | Maven 3.0 |
75+
| 4.0.0 | Maven 3.0 |
76+
| 5.0.0 | Maven 3.1.0-alpha-1 |
77+
| 6.0.0 | Maven 3.1.0-alpha-1 |
78+
| 7.0.0 | Maven 3.2.5 |
79+
80+
Flipping the table to maven:
81+
Please note that in theory maven 4.X should support all maven 3 plugins.
82+
The plugin was first shipped with maven 3 support in version v2.1.14 (requiring maven version 3.1.1).
83+
Hence the v2.1.14 should be the first supported version.
84+
Only starting with 6.X.X this plugin was acually tested with 4.0.0-alpha-5,
85+
but some releases might not work since Maven 4 announced that plugins require Maven 3.2.5 or later
86+
which would only be the case for plugin versions 7.0.0 or later.
87+
88+
| Maven Version | Plugin Version | Notes |
89+
|---------------|----------------:|:--------------------------------------------------:|
90+
| Maven 3.X | any | The plugin requires at least a maven 3.1.0-alpha-1 |
91+
| Maven 4.X | from v2.1.14 | |
7892

79-
Note:
80-
As an example -- this table should be read as: For `Maven 3.1.0` `any` Plugin Version should work, besides the ones listed in the `Notes` have the limitations listed.
8193

8294
Plugin compatibility with EOL Maven version
8395
-----------------------------
@@ -90,6 +102,12 @@ The following information is made available for reference.
90102
| Maven 2.2.1 | up to 2.2.6 | Maven 2 is EOL |
91103
| Maven 3.0.X | up to 4.0.5 | git-commit-id-plugin:2.1.14, 2.1.15, 2.2.0, 2.2.1, 2.2.3 doesn't work -- requires maven version 3.1.1 |
92104
| Maven 3.0.X | up to 4.0.5 | For git-commit-id-plugin 2.2.4 or higher: works, but failed to load class "org.slf4j.impl.StaticLoggerBinder" |
105+
| Maven 3.1.0 | any | git-commit-id-plugin:2.1.14, 2.1.15, 2.2.0, 2.2.1, 2.2.3 doesn't work -- requires maven version 3.1.1 |
106+
| Maven 3.3.1 | any | git-commit-id-plugin:2.1.14 doesn't work |
107+
| Maven 3.3.3 | any | git-commit-id-plugin:2.1.14 doesn't work |
108+
109+
Note:
110+
As an example -- this table should be read as: For `Maven 3.1.0` `any` Plugin Version should work, besides the ones listed in the `Notes` have the limitations listed.
93111

94112

95113
Getting SNAPSHOT versions of the plugin

0 commit comments

Comments
 (0)