add link to GH pages

Signed-off-by: Hervé Boutemy <[email protected]>
spdx · Jul 7, 2023 · 976895f · 976895f
1 parent 14d478c
commit 976895f
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -11,34 +11,38 @@ SPDX Maven Plugin is a plugin to Maven which produces [Software Package Data Exc
 |   [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=spdx-maven-plugin&metric=bugs)](https://sonarcloud.io/dashboard?id=spdx-maven-plugin)    | [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=spdx-maven-plugin&metric=security_rating)](https://sonarcloud.io/dashboard?id=spdx-maven-plugin) | [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=spdx-maven-plugin&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=spdx-maven-plugin) | [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=spdx-maven-plugin&metric=sqale_index)](https://sonarcloud.io/dashboard?id=spdx-maven-plugin) |
 
 # Usage
-In the build plugins section add the plugin with a goal of createSPDX:
+
+In the build plugins section, add the plugin with `createSPDX` goal:
+
 ```xml
-                <plugin>
-                    <groupId>org.spdx</groupId>
-                    <artifactId>spdx-maven-plugin</artifactId>
-                    <!-- please check for updates on https://search.maven.org/search?q=a:spdx-maven-plugin -->  
-                    <version>0.5.4</version>
-                    <executions>
-                        <execution>
-                            <id>build-spdx</id>
-                            <goals>
-                                <goal>createSPDX</goal>
-                            </goals>
-                        </execution>
-                    </executions>
-                    <configuration>
-                      <excludedFilePatterns>
-                        <excludedFilePattern>*.spdx</excludedFilePattern>
-                      </excludedFilePatterns>
-                      <!-- See documentation below for additional configuration -->
-                    </configuration>
-                </plugin>
+    <plugin>
+        <groupId>org.spdx</groupId>
+        <artifactId>spdx-maven-plugin</artifactId>
+        <!-- please check for updates on https://search.maven.org/search?q=a:spdx-maven-plugin -->
+        <version>0.6.5</version>
+        <executions>
+            <execution>
+                <id>build-spdx</id>
+                <goals>
+                    <goal>createSPDX</goal>
+                </goals>
+            </execution>
+        </executions>
+        <configuration>
+          <excludedFilePatterns>
+            <excludedFilePattern>*.spdx</excludedFilePattern>
+          </excludedFilePatterns>
+          <!-- See documentation below for additional configuration -->
+        </configuration>
+    </plugin>
 ```
 
 Then invoke with `mvn spdx:createSPDX` and your SPDX file will be generated in `./target/site/{groupId}_{artifactId}-{version}.spdx`.
 
 # Additional Configuration
 
+See [`createSPDX` goal documentation](http://spdx.github.io/spdx-maven-plugin/createSPDX-mojo.html) for complete details.
+
 All SPDX document and SPDX package properties are supported.  Some properties
 are taken from existing POM properties while others are specified in the configuration
 section.

diff --git a/pom.xml b/pom.xml
@@ -215,6 +215,24 @@
         <artifactId>maven-jar-plugin</artifactId>
         <version>3.3.0</version>
       </plugin>
+      <plugin>
+        <artifactId>maven-antrun-plugin</artifactId>
+        <version>3.0.0</version>
+        <executions>
+          <execution>
+            <phase>pre-site</phase>
+            <goals>
+              <goal>run</goal>
+            </goals>
+            <configuration>
+              <target>
+                <copy file="${project.basedir}/README.md"
+                      tofile="${project.build.directory}/generated-site/markdown/index.md"/>
+              </target>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-site-plugin</artifactId>