From cda1054b0802a6d722dd0dee780d48a72f53c3c3 Mon Sep 17 00:00:00 2001
From: BJ Hargrave <bj@hargrave.dev>
Date: Mon, 26 Sep 2022 11:28:58 -0400
Subject: [PATCH] maven: Document access to Maven properties in Bnd
 instructions

Fixes https://github.com/bndtools/bnd/issues/5375

Signed-off-by: BJ Hargrave <bj@hargrave.dev>
---
 maven/bnd-maven-plugin/README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/maven/bnd-maven-plugin/README.md b/maven/bnd-maven-plugin/README.md
index 88cd512d7d..e46d792283 100644
--- a/maven/bnd-maven-plugin/README.md
+++ b/maven/bnd-maven-plugin/README.md
@@ -180,6 +180,28 @@ The plugin will by default set some OSGi bundle headers derived from [pom elemen
 | `Bundle-Developers`   | `developers` (child element `id` must be set on each developer) |
 | `Bundle-DocURL`       | `url`                                                           |
 
+### POM Properties
+
+The Bnd instructions can reference properties defined for the Maven project and Maven settings using the `project.` and `settings.` stems, respectively.
+Other properties defined in the POM can also be referenced.
+
+```xml
+<properties>
+	<implementation.vendor>Acme Inc.</implementation.vendor>
+</properties>
+<plugin>
+  <groupId>biz.aQute.bnd</groupId>
+  <artifactId>bnd-maven-plugin</artifactId>
+  <configuration>
+    <bnd><![CDATA[
+      Implementation-Title: ${project.name}
+      Implementation-Version: ${project.version}
+      Implementation-Vendor: ${implementation.vendor}
+    ]]></bnd>
+  </configuration>
+</plugin>
+```
+
 ### Reproducible Builds
 
 If the configuration parameter `outputTimestamp` is set, indicating [reproducible][1] output, this plugin will automatically use the following Bnd instructions, if not otherwise configured.