This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-site-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 6c0b4c1d Document that site:stage needs a site URL
6c0b4c1d is described below
commit 6c0b4c1d746a9e1ab25f74245cb6a002d00f49db
Author: Sylwester Lachiewicz <[email protected]>
AuthorDate: Tue Nov 3 21:55:08 2026 +0000
Document that site:stage needs a site URL
---
src/site/markdown/usage.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/src/site/markdown/usage.md b/src/site/markdown/usage.md
index 6b7d5b4f..1fe16dc3 100644
--- a/src/site/markdown/usage.md
+++ b/src/site/markdown/usage.md
@@ -93,6 +93,17 @@ mvn site:stage
**Note:** A site must be generated first before executing `site:stage`.
+`site:stage` works out where each module goes in the staged site from the site
URLs in `<distributionManagement>`, so the project, or a parent it inherits
from, needs a `<site>` element with both an `<id>` and a `<url>`, even though
nothing is deployed there. A project that publishes its site some other way,
for example with the [Maven SCM Publish
Plugin](/plugins/maven-scm-publish-plugin/), can use any URL:
+
+```xml
+<distributionManagement>
+ <site>
+ <id>local</id>
+ <url>file:///tmp/site</url>
+ </site>
+</distributionManagement>
+```
+
By default, the site will be staged in a directory `target/staging/`. A
different staging location can be chosen with the `stagingDirectory` parameter
as shown below:
```shell