AlexanderAshitkin commented on a change in pull request #631: URL: https://github.com/apache/maven/pull/631#discussion_r763123384
########## File path: maven-caching-extension/src/site/markdown/CACHE-USAGE.md ########## @@ -0,0 +1,46 @@ +<!--- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You 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. +--> + +## Normal usage + +Once extension is activated, cache will kick-in automatically on every lifecycle build of phase `package` or higher. + +## Subtree builds + +Build could be invoked on any module in project and will try to discover cache by introspecting dependencies. In order +to identify which dependencies are part of cacheable project the cache engine needs to know: + +* full project root location which must be passed with `-Dmaven.multiModuleProjectDirectory` Review comment: Indeed, this is an implementation detail which must be satisfied in order to make this functionality work correctly. So it is unavoidably required in this implementation and in particular for subtree feature, when build could be started at any module within project. Maybe there is a better way to implement this, but so far this is required by implementation -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
