This is an automated email from the ASF dual-hosted git repository.
olamy pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/maven-build-cache-extension.git
The following commit(s) were added to refs/heads/master by this push:
new 44a179a Filter the project version into the getting started guide
(#70)
44a179a is described below
commit 44a179a39e79dd0b94aa68e178c174ec9667f174
Author: Brian Demers <[email protected]>
AuthorDate: Wed Apr 19 17:44:21 2023 -0400
Filter the project version into the getting started guide (#70)
Adding `.vm` to the end of the file allows interpolating files.
---
.../markdown/{getting-started.md => getting-started.md.vm} | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/src/site/markdown/getting-started.md
b/src/site/markdown/getting-started.md.vm
similarity index 93%
rename from src/site/markdown/getting-started.md
rename to src/site/markdown/getting-started.md.vm
index 213137e..4f9e230 100644
--- a/src/site/markdown/getting-started.md
+++ b/src/site/markdown/getting-started.md.vm
@@ -15,7 +15,8 @@
limitations under the License.
-->
-## Getting Started
+Getting Started
+---------------
To on-board incremental Maven you need to complete several steps:
@@ -24,19 +25,19 @@ To on-board incremental Maven you need to complete several
steps:
* Validate build results and iteratively, adjust config to properly reflect
project specifics
* Setup remote cache (optional)
-### Declaring build cache extension
+#[[###]]# Declaring build cache extension
```xml
<extension>
<groupId>org.apache.maven.extensions</groupId>
<artifactId>maven-build-cache-extension</artifactId>
- <version>1.0.0-SNAPSHOT</version>
+ <version>${project.version}</version>
</extension>
```
either in `pom.xml`'s `<project>/<build>/<extensions>` or in
`.mvn/extensions.xml`'s `<extensions>`
-### Adding build cache config
+#[[###]]# Adding build cache config
Copy template config
[`maven-build-cache-config.xml`](../resources/maven-build-cache-config.xml)
to [`.mvn/`](https://maven.apache.org/configure.html) directory of your
project.
@@ -49,7 +50,7 @@ scenario you need to:
there might be edge cases.
* Add remote cache location (if remote cache is used)
-### Adjusting build cache config
+#[[###]]# Adjusting build cache config
Having extension run usual command, like `mvn package`. Verify the caching
engine is activated:
@@ -66,7 +67,7 @@ Having extension run usual command, like `mvn package`.
Verify the caching engin
It is recommended to find the best working trade-off between fairness and
cache efficiency. Adding unnecessary rules and
checks could reduce both performance and cache efficiency (hit rate).
-### Adding caching CI and remote cache
+#[[###]]# Adding caching CI and remote cache
To leverage remote cache feature there should a shared storage provide. Any
technology supported
by [Maven Resolver](https://maven.apache.org/resolver/) will suffice. In
simplest form it could be a http web server which
