You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2021/11/08 21:02:09 UTC
[maven] branch MNG-7129_Modello updated (7159691 -> d539242)
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a change to branch MNG-7129_Modello
in repository https://gitbox.apache.org/repos/asf/maven.git.
from 7159691 [MNG-7324] remove now unused JAXB dependencies
new b9985c8 [MNG-7324] update documentation
new d539242 [MNG-7324] extract config classes to separate package from domain
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
Documentation/CACHE-HOWTO.md | 19 +++++-----
Documentation/CACHE-PARAMETERS.md | 4 +-
Documentation/CACHE-REMOTE.md | 8 ++--
Documentation/CACHE.md | 44 +++++++++++-----------
Documentation/maven-cache-config.xml | 5 +--
.../apache/maven/caching/CacheControllerImpl.java | 10 ++---
.../maven/caching/DefaultPluginScanConfig.java | 2 +-
.../apache/maven/caching/MojoExecutionManager.java | 2 +-
.../org/apache/maven/caching/PluginScanConfig.java | 2 +-
.../apache/maven/caching/PluginScanConfigImpl.java | 6 +--
.../maven/caching/checksum/MavenProjectInput.java | 9 ++---
.../org/apache/maven/caching/xml/CacheConfig.java | 8 ++--
.../apache/maven/caching/xml/CacheConfigImpl.java | 38 +++++++++----------
.../org/apache/maven/caching/xml/DtoUtils.java | 2 +-
.../org/apache/maven/caching/xml/XmlService.java | 6 +--
maven-core/src/main/mdo/cache-config.mdo | 4 +-
maven-core/src/main/mdo/cache-domain.mdo | 4 +-
.../apache/maven/caching/xml/CacheConfigTest.java | 4 +-
18 files changed, 88 insertions(+), 89 deletions(-)
[maven] 02/02: [MNG-7324] extract config classes to separate
package from domain
Posted by hb...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch MNG-7129_Modello
in repository https://gitbox.apache.org/repos/asf/maven.git
commit d539242171d48203f53a10511ef04af97c5b040b
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Mon Nov 8 22:02:06 2021 +0100
[MNG-7324] extract config classes to separate package from domain
---
.../apache/maven/caching/CacheControllerImpl.java | 10 +++---
.../maven/caching/DefaultPluginScanConfig.java | 2 +-
.../apache/maven/caching/MojoExecutionManager.java | 2 +-
.../org/apache/maven/caching/PluginScanConfig.java | 2 +-
.../apache/maven/caching/PluginScanConfigImpl.java | 6 ++--
.../maven/caching/checksum/MavenProjectInput.java | 9 +++--
.../org/apache/maven/caching/xml/CacheConfig.java | 8 ++---
.../apache/maven/caching/xml/CacheConfigImpl.java | 38 +++++++++++-----------
.../org/apache/maven/caching/xml/DtoUtils.java | 2 +-
.../org/apache/maven/caching/xml/XmlService.java | 6 ++--
maven-core/src/main/mdo/cache-config.mdo | 2 +-
.../apache/maven/caching/xml/CacheConfigTest.java | 4 +--
12 files changed, 44 insertions(+), 47 deletions(-)
diff --git a/maven-core/src/main/java/org/apache/maven/caching/CacheControllerImpl.java b/maven-core/src/main/java/org/apache/maven/caching/CacheControllerImpl.java
index 05e56a5..0114952 100644
--- a/maven-core/src/main/java/org/apache/maven/caching/CacheControllerImpl.java
+++ b/maven-core/src/main/java/org/apache/maven/caching/CacheControllerImpl.java
@@ -31,9 +31,8 @@ import org.apache.maven.artifact.handler.ArtifactHandler;
import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
import org.apache.maven.caching.checksum.KeyUtils;
import org.apache.maven.caching.checksum.MavenProjectInput;
-import org.apache.maven.caching.domain.Scm;
-import org.apache.maven.caching.hash.HashAlgorithm;
-import org.apache.maven.caching.hash.HashFactory;
+import org.apache.maven.caching.config.PropertyNameType;
+import org.apache.maven.caching.config.TrackedPropertyType;
import org.apache.maven.caching.domain.ArtifactType;
import org.apache.maven.caching.domain.BuildDiffType;
import org.apache.maven.caching.domain.CacheReportType;
@@ -41,8 +40,9 @@ import org.apache.maven.caching.domain.CompletedExecutionType;
import org.apache.maven.caching.domain.DigestItemType;
import org.apache.maven.caching.domain.ProjectReportType;
import org.apache.maven.caching.domain.ProjectsInputInfoType;
-import org.apache.maven.caching.domain.PropertyNameType;
-import org.apache.maven.caching.domain.TrackedPropertyType;
+import org.apache.maven.caching.domain.Scm;
+import org.apache.maven.caching.hash.HashAlgorithm;
+import org.apache.maven.caching.hash.HashFactory;
import org.apache.maven.caching.xml.BuildInfo;
import org.apache.maven.caching.xml.CacheConfig;
import org.apache.maven.caching.xml.CacheSource;
diff --git a/maven-core/src/main/java/org/apache/maven/caching/DefaultPluginScanConfig.java b/maven-core/src/main/java/org/apache/maven/caching/DefaultPluginScanConfig.java
index 8229435..e29bf72 100644
--- a/maven-core/src/main/java/org/apache/maven/caching/DefaultPluginScanConfig.java
+++ b/maven-core/src/main/java/org/apache/maven/caching/DefaultPluginScanConfig.java
@@ -19,7 +19,7 @@ package org.apache.maven.caching;
* under the License.
*/
-import org.apache.maven.caching.domain.DirScanConfigType;
+import org.apache.maven.caching.config.DirScanConfigType;
import javax.annotation.Nonnull;
diff --git a/maven-core/src/main/java/org/apache/maven/caching/MojoExecutionManager.java b/maven-core/src/main/java/org/apache/maven/caching/MojoExecutionManager.java
index a6e1936..a03babb 100644
--- a/maven-core/src/main/java/org/apache/maven/caching/MojoExecutionManager.java
+++ b/maven-core/src/main/java/org/apache/maven/caching/MojoExecutionManager.java
@@ -20,8 +20,8 @@ package org.apache.maven.caching;
*/
import org.apache.commons.lang3.StringUtils;
+import org.apache.maven.caching.config.TrackedPropertyType;
import org.apache.maven.caching.domain.CompletedExecutionType;
-import org.apache.maven.caching.domain.TrackedPropertyType;
import org.apache.maven.caching.xml.BuildInfo;
import org.apache.maven.caching.xml.CacheConfig;
import org.apache.maven.caching.xml.DtoUtils;
diff --git a/maven-core/src/main/java/org/apache/maven/caching/PluginScanConfig.java b/maven-core/src/main/java/org/apache/maven/caching/PluginScanConfig.java
index a3af7b6..4e88263 100644
--- a/maven-core/src/main/java/org/apache/maven/caching/PluginScanConfig.java
+++ b/maven-core/src/main/java/org/apache/maven/caching/PluginScanConfig.java
@@ -19,7 +19,7 @@ package org.apache.maven.caching;
* under the License.
*/
-import org.apache.maven.caching.domain.DirScanConfigType;
+import org.apache.maven.caching.config.DirScanConfigType;
import javax.annotation.Nonnull;
diff --git a/maven-core/src/main/java/org/apache/maven/caching/PluginScanConfigImpl.java b/maven-core/src/main/java/org/apache/maven/caching/PluginScanConfigImpl.java
index 1c5ea65..a743c62 100644
--- a/maven-core/src/main/java/org/apache/maven/caching/PluginScanConfigImpl.java
+++ b/maven-core/src/main/java/org/apache/maven/caching/PluginScanConfigImpl.java
@@ -20,9 +20,9 @@ package org.apache.maven.caching;
*/
import org.apache.commons.lang3.StringUtils;
-import org.apache.maven.caching.domain.DirScanConfigType;
-import org.apache.maven.caching.domain.TagNameType;
-import org.apache.maven.caching.domain.TagScanConfigType;
+import org.apache.maven.caching.config.DirScanConfigType;
+import org.apache.maven.caching.config.TagNameType;
+import org.apache.maven.caching.config.TagScanConfigType;
import javax.annotation.Nonnull;
import java.util.List;
diff --git a/maven-core/src/main/java/org/apache/maven/caching/checksum/MavenProjectInput.java b/maven-core/src/main/java/org/apache/maven/caching/checksum/MavenProjectInput.java
index 56fbaed..c569a21 100644
--- a/maven-core/src/main/java/org/apache/maven/caching/checksum/MavenProjectInput.java
+++ b/maven-core/src/main/java/org/apache/maven/caching/checksum/MavenProjectInput.java
@@ -19,7 +19,6 @@ package org.apache.maven.caching.checksum;
* under the License.
*/
-
import com.google.common.base.Optional;
import com.google.common.collect.Iterables;
import org.apache.commons.lang3.StringUtils;
@@ -33,13 +32,13 @@ import org.apache.maven.caching.PluginScanConfig;
import org.apache.maven.caching.ProjectUtils;
import org.apache.maven.caching.RemoteArtifactsRepository;
import org.apache.maven.caching.ScanConfigProperties;
-import org.apache.maven.caching.domain.Exclude;
-import org.apache.maven.caching.hash.HashAlgorithm;
-import org.apache.maven.caching.hash.HashChecksum;
+import org.apache.maven.caching.config.Exclude;
+import org.apache.maven.caching.config.Include;
import org.apache.maven.caching.hash.HashFactory;
import org.apache.maven.caching.domain.DigestItemType;
-import org.apache.maven.caching.domain.Include;
import org.apache.maven.caching.domain.ProjectsInputInfoType;
+import org.apache.maven.caching.hash.HashAlgorithm;
+import org.apache.maven.caching.hash.HashChecksum;
import org.apache.maven.caching.xml.BuildInfo;
import org.apache.maven.caching.xml.CacheConfig;
import org.apache.maven.caching.xml.DtoUtils;
diff --git a/maven-core/src/main/java/org/apache/maven/caching/xml/CacheConfig.java b/maven-core/src/main/java/org/apache/maven/caching/xml/CacheConfig.java
index a9dd950..acd79f3 100644
--- a/maven-core/src/main/java/org/apache/maven/caching/xml/CacheConfig.java
+++ b/maven-core/src/main/java/org/apache/maven/caching/xml/CacheConfig.java
@@ -21,11 +21,11 @@ package org.apache.maven.caching.xml;
import org.apache.maven.caching.PluginScanConfig;
import org.apache.maven.caching.checksum.MultimoduleDiscoveryStrategy;
-import org.apache.maven.caching.domain.Exclude;
+import org.apache.maven.caching.config.Exclude;
+import org.apache.maven.caching.config.Include;
+import org.apache.maven.caching.config.PropertyNameType;
+import org.apache.maven.caching.config.TrackedPropertyType;
import org.apache.maven.caching.hash.HashFactory;
-import org.apache.maven.caching.domain.Include;
-import org.apache.maven.caching.domain.PropertyNameType;
-import org.apache.maven.caching.domain.TrackedPropertyType;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Plugin;
import org.apache.maven.model.PluginExecution;
diff --git a/maven-core/src/main/java/org/apache/maven/caching/xml/CacheConfigImpl.java b/maven-core/src/main/java/org/apache/maven/caching/xml/CacheConfigImpl.java
index df8eb26..e1cb63d 100644
--- a/maven-core/src/main/java/org/apache/maven/caching/xml/CacheConfigImpl.java
+++ b/maven-core/src/main/java/org/apache/maven/caching/xml/CacheConfigImpl.java
@@ -26,26 +26,26 @@ import org.apache.maven.caching.DefaultPluginScanConfig;
import org.apache.maven.caching.PluginScanConfig;
import org.apache.maven.caching.PluginScanConfigImpl;
import org.apache.maven.caching.checksum.MultimoduleDiscoveryStrategy;
-import org.apache.maven.caching.domain.AttachedOutputs;
-import org.apache.maven.caching.domain.Exclude;
-import org.apache.maven.caching.domain.Include;
-import org.apache.maven.caching.domain.Local;
-import org.apache.maven.caching.domain.ProjectDiscoveryStrategy;
-import org.apache.maven.caching.domain.Remote;
+import org.apache.maven.caching.config.AttachedOutputs;
+import org.apache.maven.caching.config.Exclude;
+import org.apache.maven.caching.config.Include;
+import org.apache.maven.caching.config.Local;
+import org.apache.maven.caching.config.ProjectDiscoveryStrategy;
+import org.apache.maven.caching.config.Remote;
+import org.apache.maven.caching.config.CacheType;
+import org.apache.maven.caching.config.ConfigurationType;
+import org.apache.maven.caching.config.CoordinatesBaseType;
+import org.apache.maven.caching.config.ExecutablesType;
+import org.apache.maven.caching.config.ExecutionConfigurationScanType;
+import org.apache.maven.caching.config.ExecutionControlType;
+import org.apache.maven.caching.config.ExecutionIdsListType;
+import org.apache.maven.caching.config.GoalReconciliationType;
+import org.apache.maven.caching.config.GoalsListType;
+import org.apache.maven.caching.config.PluginConfigurationScanType;
+import org.apache.maven.caching.config.PluginSetType;
+import org.apache.maven.caching.config.PropertyNameType;
+import org.apache.maven.caching.config.TrackedPropertyType;
import org.apache.maven.caching.hash.HashFactory;
-import org.apache.maven.caching.domain.CacheType;
-import org.apache.maven.caching.domain.ConfigurationType;
-import org.apache.maven.caching.domain.CoordinatesBaseType;
-import org.apache.maven.caching.domain.ExecutablesType;
-import org.apache.maven.caching.domain.ExecutionConfigurationScanType;
-import org.apache.maven.caching.domain.ExecutionControlType;
-import org.apache.maven.caching.domain.ExecutionIdsListType;
-import org.apache.maven.caching.domain.GoalReconciliationType;
-import org.apache.maven.caching.domain.GoalsListType;
-import org.apache.maven.caching.domain.PluginConfigurationScanType;
-import org.apache.maven.caching.domain.PluginSetType;
-import org.apache.maven.caching.domain.PropertyNameType;
-import org.apache.maven.caching.domain.TrackedPropertyType;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Plugin;
import org.apache.maven.model.PluginExecution;
diff --git a/maven-core/src/main/java/org/apache/maven/caching/xml/DtoUtils.java b/maven-core/src/main/java/org/apache/maven/caching/xml/DtoUtils.java
index 7bd2d2b..43be43c 100644
--- a/maven-core/src/main/java/org/apache/maven/caching/xml/DtoUtils.java
+++ b/maven-core/src/main/java/org/apache/maven/caching/xml/DtoUtils.java
@@ -23,11 +23,11 @@ import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.caching.ProjectUtils;
+import org.apache.maven.caching.config.TrackedPropertyType;
import org.apache.maven.caching.domain.ArtifactType;
import org.apache.maven.caching.domain.CompletedExecutionType;
import org.apache.maven.caching.domain.DigestItemType;
import org.apache.maven.caching.domain.PropertyValueType;
-import org.apache.maven.caching.domain.TrackedPropertyType;
import org.apache.maven.model.Dependency;
import javax.annotation.Nonnull;
diff --git a/maven-core/src/main/java/org/apache/maven/caching/xml/XmlService.java b/maven-core/src/main/java/org/apache/maven/caching/xml/XmlService.java
index 6419c8f..d0ef1a7 100644
--- a/maven-core/src/main/java/org/apache/maven/caching/xml/XmlService.java
+++ b/maven-core/src/main/java/org/apache/maven/caching/xml/XmlService.java
@@ -19,9 +19,9 @@ package org.apache.maven.caching.xml;
* under the License.
*/
-import org.apache.maven.caching.domain.CacheType;
-import org.apache.maven.caching.domain.io.xpp3.CacheConfigXpp3Reader;
-import org.apache.maven.caching.domain.io.xpp3.CacheConfigXpp3Writer;
+import org.apache.maven.caching.config.CacheType;
+import org.apache.maven.caching.config.io.xpp3.CacheConfigXpp3Reader;
+import org.apache.maven.caching.config.io.xpp3.CacheConfigXpp3Writer;
import org.apache.maven.caching.domain.io.xpp3.CacheDiffXpp3Reader;
import org.apache.maven.caching.domain.io.xpp3.CacheDiffXpp3Writer;
import org.apache.maven.caching.domain.io.xpp3.CacheDomainXpp3Reader;
diff --git a/maven-core/src/main/mdo/cache-config.mdo b/maven-core/src/main/mdo/cache-config.mdo
index 99cbec0..68bbea1 100644
--- a/maven-core/src/main/mdo/cache-config.mdo
+++ b/maven-core/src/main/mdo/cache-config.mdo
@@ -30,7 +30,7 @@ under the License.
<defaults>
<default>
<key>package</key>
- <value>org.apache.maven.caching.domain</value>
+ <value>org.apache.maven.caching.config</value>
</default>
</defaults>
diff --git a/maven-core/src/test/java/org/apache/maven/caching/xml/CacheConfigTest.java b/maven-core/src/test/java/org/apache/maven/caching/xml/CacheConfigTest.java
index c589181..911cb68 100644
--- a/maven-core/src/test/java/org/apache/maven/caching/xml/CacheConfigTest.java
+++ b/maven-core/src/test/java/org/apache/maven/caching/xml/CacheConfigTest.java
@@ -19,12 +19,10 @@ package org.apache.maven.caching.xml;
* under the License.
*/
-import org.apache.maven.caching.domain.CacheType;
+import org.apache.maven.caching.config.CacheType;
import org.junit.Test;
import java.io.InputStream;
-import java.nio.file.Path;
-import java.nio.file.Paths;
public class CacheConfigTest {
[maven] 01/02: [MNG-7324] update documentation
Posted by hb...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch MNG-7129_Modello
in repository https://gitbox.apache.org/repos/asf/maven.git
commit b9985c817386f2c6bea5d68d2e84c854ed55bc52
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Mon Nov 8 21:43:03 2021 +0100
[MNG-7324] update documentation
---
Documentation/CACHE-HOWTO.md | 19 +++++++-------
Documentation/CACHE-PARAMETERS.md | 4 +--
Documentation/CACHE-REMOTE.md | 8 +++---
Documentation/CACHE.md | 44 ++++++++++++++++----------------
Documentation/maven-cache-config.xml | 5 ++--
maven-core/src/main/mdo/cache-config.mdo | 2 ++
maven-core/src/main/mdo/cache-domain.mdo | 4 ++-
7 files changed, 44 insertions(+), 42 deletions(-)
diff --git a/Documentation/CACHE-HOWTO.md b/Documentation/CACHE-HOWTO.md
index aa15f62..77d03ba 100644
--- a/Documentation/CACHE-HOWTO.md
+++ b/Documentation/CACHE-HOWTO.md
@@ -17,18 +17,17 @@
### Overview
-Cache configuration provides you additional control over incremental maven behavior. Follow it step by step to
+Cache configuration provides you additional control over incremental Maven behavior. Follow it step by step to
understand how it works and figure out your optimal config
### Minimal config
-Absolutely minimal config which enables incremental maven with local cache
+Absolutely minimal config which enables incremental Maven with local cache
```xml
<?xml version="1.0" encoding="UTF-8" ?>
-<cache xmlns="org:apache:maven:cache:config:v1"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="org:apache:maven:cache:config:v1 cache-config.xsd">
+<cache xmlns="org:apache:maven:cache:config:v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="org:apache:maven:cache:config:v1 http://maven.apache.org/xsd/cache-config-1.0.0.xsd">
<configuration>
<enabled>true</enabled>
@@ -73,7 +72,7 @@ Add all the project specific source code files in `<glob>`. Scala in this case:
### Adding source directory for bespoke project layouts
-In most of the cases incremental maven will recognize directories automatically by build introspection. If not, you can
+In most of the cases incremental Maven will recognize directories automatically by build introspection. If not, you can
add additional directories with `<include>`. Also you can filter out undesirable dirs and files by using exclude tag
```xml
@@ -134,7 +133,7 @@ Add `executionControl/runAlways` section
```xml
<?xml version="1.0" encoding="UTF-8" ?>
<cache xmlns="org:apache:maven:cache:config:v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="org:apache:maven:cache:config:v1 cache-config.xsd">
+ xsi:schemaLocation="org:apache:maven:cache:config:v1 http://maven.apache.org/xsd/cache-config-1.0.0.xsd">
<configuration>
...
</configuration>
@@ -157,7 +156,7 @@ Add `executionControl/runAlways` section
### I occasionally cached build with `-DskipTests=true` and tests do not run now
-If you add command line flags to your build, they do not participate in effective pom - maven defers final value
+If you add command line flags to your build, they do not participate in effective pom - Maven defers final value
resolution to plugin runtime. To invalidate build if filed value is different in runtime, add reconciliation section
to `executionControl`:
@@ -180,7 +179,7 @@ to `executionControl`:
Please notice `skipValue` attribute. It denotes value which forces skipped execution.
Read `propertyName="skipTests" skipValue="true"` as if property skipTests has value true, plugin will skip execution If
-you declare such value incremental maven will reuse appropriate full-build though technically they are different, but
+you declare such value incremental Maven will reuse appropriate full-build though technically they are different, but
because full-build is better it is safe to reuse
### How to renormalize line endings in working copy after committing .gitattributes (git 2.16+)
@@ -201,4 +200,4 @@ git reset --hard
### I want to cache interim build and override it later with final version
Solution: set `-Dremote.cache.save.final=true` to nodes which produce final builds. Such builds will not be overridden
-and eventually will replace all interim builds
\ No newline at end of file
+and eventually will replace all interim builds
diff --git a/Documentation/CACHE-PARAMETERS.md b/Documentation/CACHE-PARAMETERS.md
index 7633ddb..12042c6 100644
--- a/Documentation/CACHE-PARAMETERS.md
+++ b/Documentation/CACHE-PARAMETERS.md
@@ -26,8 +26,8 @@ This documents contains various configuration parameters supported by cache engi
| `-Dremote.cache.configPath=true/false` | Location of cache configuration file | Cache config is not in default location |
| `-Dremote.cache.enabled=true/false` | Remote cache and associated features disabled/enabled | To remove noise from logs then remote cache is not available |
| `-Dremote.cache.save.enabled=true/false` | Remote cache save allowed or not | To designate nodes which allowed to push in remote shared cache |
-| `-Dremote.cache.save.final=true/false` | Is it allowed or not to override produced cache | To ensure that reference build is not overriden by interim build |
-| `-Dremote.cache.failFast=true/false` | Fail on the first module whcih cannot be restored from cache | Remote cache setup/tuning/troubleshooting |
+| `-Dremote.cache.save.final=true/false` | Is it allowed or not to override produced cache | To ensure that reference build is not overridden by interim build |
+| `-Dremote.cache.failFast=true/false` | Fail on the first module which cannot be restored from cache | Remote cache setup/tuning/troubleshooting |
| `-Dremote.cache.baselineUrl=<http url>` | Location of baseline build for comparison | Remote cache setup/tuning/troubleshooting |
## Project level properties
diff --git a/Documentation/CACHE-REMOTE.md b/Documentation/CACHE-REMOTE.md
index f5fe387..c89e5de 100644
--- a/Documentation/CACHE-REMOTE.md
+++ b/Documentation/CACHE-REMOTE.md
@@ -17,7 +17,7 @@
# Overview
-This document describes generic approach to cache setup. The process require expertise in maven equivalent to expertise
+This document describes generic approach to cache setup. The process require expertise in Maven equivalent to expertise
required to author and Maven your project build, it implies good knowledge of both Maven and the project. Due to Maven
model limitation the process is manual, but allows you to achieve sufficient control and transparency over caching
logic.
@@ -113,8 +113,8 @@ Once discrepancy between remote and local builds detected cache will fail with d
in `target/incremental-maven` directory:
```
-* buildinfo-baseline-3c64673e23259e6f.xml - build specficiation from baseline build
-* buildinfo-db43936e0666ce7.xml - build specification of locall build
+* buildinfo-baseline-3c64673e23259e6f.xml - build specification from baseline build
+* buildinfo-db43936e0666ce7.xml - build specification of local build
* buildsdiff.xml - comparison report with list of discrepancies
```
@@ -242,7 +242,7 @@ relax consistency rules in favor of compatibility, remove property from tracked
Current implementation doesn't support version changes between cache entries. It will result in cache invalidation for
each new version.
-To mitigate the issue please consider migrating off traditional maven release approach - try to use single version id in
+To mitigate the issue please consider migrating off traditional Maven release approach - try to use single version id in
project (eg `<version>MY-PROJECT-LOCAL</version>`). Such approach simplifies git branching workflow significantly.
Deployment of artifacts with specific version from builds with cache is not supported yet.
diff --git a/Documentation/CACHE.md b/Documentation/CACHE.md
index 391becc..7449ef5 100644
--- a/Documentation/CACHE.md
+++ b/Documentation/CACHE.md
@@ -17,19 +17,19 @@
## Overview
-Idea of Incremental Maven is to specify module inputs and outputs and make them known to standard maven core. This
+Idea of Incremental Maven is to specify module inputs and outputs and make them known to standard Maven core. This
allows accurate analysis and determination of out-of-date build artifacts in the build dependencies graph. Making the
dependency graph analysis deterministic leads to improvements in build times by avoiding re-building unnecessary
modules.
-Cache does not make any low-level interventions to build process and delegates actual build work to maven core. This
-guarantees that build results are identical to results produced by standard maven and are fully reproducible.
-To achieve accurate input and outputs calculation incremental maven combines automatic introspection
+Cache does not make any low-level interventions to build process and delegates actual build work to Maven core. This
+guarantees that build results are identical to results produced by standard Maven and are fully reproducible.
+To achieve accurate input and outputs calculation incremental Maven combines automatic introspection
of [project object model](https://maven.apache.org/pom.html#What_is_the_POM) in conjunction with configuration-driven
rules for fine-grained content and execution control. For content analysis it digests based approach which is more
reliable over widely used file timestamps in tools like Make or Apache Ant. Deterministic build state allows reliably
cache even intermediate outputs of build and share them between teams using remote cache. Deterministic inputs
calculation allows distributed and parallel builds running in heterogeneous environments (like cloud of build agents)
-could efficiently reuse cached build artifacts. Therefore incremental maven is particularly well-suited for large maven
+could efficiently reuse cached build artifacts. Therefore incremental Maven is particularly well-suited for large Maven
projects that have significant number of small modules. Remote cache in conjunction with precise input identification
effectively enables "change once - build once" approach.
@@ -51,7 +51,7 @@ of today build with some tolerance (implementation, configuration and environmen
### Implementation insights
-At very simple form, the incremental maven is essentially a hash function which takes maven project and produces hash
+At very simple form, the incremental Maven is essentially a hash function which takes Maven project and produces hash
code (checksum). Then hash value is used to fetch and restore build result.
As with any hash, there could be collisions and instabilities. Collision could happen if the same hash produced from the
different build states and will result in unintended reuse. Instability means that same input yields different hash sums
@@ -79,7 +79,7 @@ verification it's still consumer's responsibility to verify final product qualit
Given all the information above, the Incremental Maven is recommended to use in scenarios when productivity and
performance are in priority. Typical cases are:
-* Speedup CI. In conjunction with remote cache incremental maven could drastically reduce build times, validate pull
+* Speedup CI. In conjunction with remote cache incremental Maven could drastically reduce build times, validate pull
requests faster and reduce load on CI nodes
* Speedup developer builds. By reusing cached builds developers could verify changes much faster and be more productive.
No more `-DskipTests` and similar.
@@ -92,35 +92,35 @@ This also allows you to validate cache correctness and reconcile cache outcomes
## Getting Started
-To on-board incremental maven you need to complete several steps:
+To on-board incremental Maven you need to complete several steps:
-* Get incremental maven distribution
-* Add cache config in .mvn
+* Get incremental Maven distribution
+* Add cache config in `.mvn`
* Validate build results and iteratively adjust config to project specifics
-* Migrate CI to incremental maven with remote cache (to get full benefit) - optional
+* Migrate CI to incremental Maven with remote cache (to get full benefit) - optional
-### Get incremental maven distribution
+### Get incremental Maven distribution
The recommended way is to add [Takari Maven Wrapper](https://github.com/takari/maven-wrapper) to your project. In that
-case `maven-wrapper.properties` should reference the latest incremental maven distribution:
+case `maven-wrapper.properties` should reference the latest incremental Maven distribution:
```properties
distributionUrl=https://your-server/maven-incremental.zip
wrapperUrl=https://your-server/maven-wrapper-0.5.5.jar
```
-Benefits of using maven wrapper are following:
+Benefits of using Maven wrapper are following:
* simple distribution across workstations and CI envs
-* maven stays compatible to your branch
+* Maven stays compatible to your branch
* further upgrades are simplified significantly
- If you refuse wrapper - then download, unzip and install it just as usual maven. Further it will be assumed you use
- maven wrapper (`mvnw`)
+ If you refuse wrapper - then download, unzip and install it just as usual Maven. Further it will be assumed you use
+ Maven wrapper (`mvnw`)
### Adding cache config
-Copy [default config](maven-cache-config.xml) and [xml schema](../maven-core/src/main/resources/cache-config.xsd)
-to [.mvn](https://maven.apache.org/configure.html) dir of yor project.
+Copy [default config `maven-cache-config.xml`](maven-cache-config.xml)
+to [`.mvn/`](https://maven.apache.org/configure.html) dir of your project.
To get overall understanding of cache machinery it is recommended to review the config and read comments. In typical
scenario you need to adjust:
@@ -135,15 +135,15 @@ See also:
* [Remote cache setup](CACHE-REMOTE.md) - instruction how to setup shared cache
* [Cache How-To](CACHE-HOWTO.md) - cookbook for frequently encountered questions
* [Cache Parameters](CACHE-PARAMETERS.md) - description of supported parameters
-* Attached [sample config file](maven-cache-config.xml) and elements annotations in xsd schema. (Ctrl+Q in idea should
+* Attached [sample `maven-cache-config.xml` config file](maven-cache-config.xml) and elements annotations in xsd schema. (Ctrl+Q in idea should
show annotations in popup)
### Adjusting cache config
-Having incremental maven and the config in place you're all set. To run first cacheable build just
+Having incremental Maven and the config in place you're all set. To run first cacheable build just
execute: `mvnw clean install`
-* Ensure that the config is picked up and incremental maven is picked up. Just check log output - you will notice cache
+* Ensure that the config is picked up and incremental Maven is picked up. Just check log output - you will notice cache
related output or initialization error message.
* Navigate to your local repo directory - there should be sibling next to your local repo named `cache`
* Find `buildinfo.xml` for typical module and review it. Ensure that
diff --git a/Documentation/maven-cache-config.xml b/Documentation/maven-cache-config.xml
index a2a7ad8..12425fd 100644
--- a/Documentation/maven-cache-config.xml
+++ b/Documentation/maven-cache-config.xml
@@ -15,9 +15,8 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<cache xmlns="org:apache:maven:cache:config:v1"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="org:apache:maven:cache:config:v1 cache-config.xsd">
+<cache xmlns="org:apache:maven:cache:config:v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="org:apache:maven:cache:config:v1 http://maven.apache.org/xsd/cache-config-1.0.0.xsd">
<configuration>
<enabled>true</enabled>
diff --git a/maven-core/src/main/mdo/cache-config.mdo b/maven-core/src/main/mdo/cache-config.mdo
index 5160bb8..99cbec0 100644
--- a/maven-core/src/main/mdo/cache-config.mdo
+++ b/maven-core/src/main/mdo/cache-config.mdo
@@ -19,6 +19,8 @@ under the License.
<model xmlns="http://codehaus-plexus.github.io/MODELLO/1.4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://codehaus-plexus.github.io/MODELLO/1.4.0 http://codehaus-plexus.github.io/modello/xsd/modello-1.4.0.xsd"
+ xml.namespace="http://maven.apache.org/CACHE/${version}"
+ xml.schemaLocation="http://maven.apache.org/xsd/cache-config-${version}.xsd"
xsd.namespace="org:apache:maven:cache:config">
<id>cache-config</id>
<name>CacheConfig</name>
diff --git a/maven-core/src/main/mdo/cache-domain.mdo b/maven-core/src/main/mdo/cache-domain.mdo
index 43c3530..44ccdd6 100644
--- a/maven-core/src/main/mdo/cache-domain.mdo
+++ b/maven-core/src/main/mdo/cache-domain.mdo
@@ -19,6 +19,8 @@ under the License.
<model xmlns="http://codehaus-plexus.github.io/MODELLO/1.4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://codehaus-plexus.github.io/MODELLO/1.4.0 http://codehaus-plexus.github.io/modello/xsd/modello-1.4.0.xsd"
+ xml.namespace="http://maven.apache.org/CACHE/DOMAIN/${version}"
+ xml.schemaLocation="http://maven.apache.org/xsd/cache-domain-${version}.xsd"
xsd.namespace="org:apache:maven:cache:domain">
<id>cache-domain</id>
<name>CacheDomain</name>
@@ -35,7 +37,7 @@ under the License.
<class rootElement="true" xml.tagName="build">
<name>BuildInfoType</name>
<version>1.0.0+</version>
- <description><![CDATA[Root element of the <code>extension.xml</code> file.]]></description>
+ <description></description>
<!--xs:all-->
<fields>
<!-- xs:element name="cacheImplementationVersion" type="xs:string"/-->