Docs: get release version from GitHub release (#136)

* add version from GitHub to asciidoc

* add update version to the target execution

Author: maximthomas

commons/doc-maven-plugin/pom.xml

@@ -13,7 +13,7 @@
  * information: "Portions copyright [year] [name of copyright owner]".
  *
  * Copyright 2012-2015 ForgeRock AS.
- * Portions copyright 2024 3A Systems LLC.
+ * Portions copyright 2024-2025 3A Systems LLC.
 -->
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
@@ -163,6 +163,10 @@
    <groupId>org.asciidoctor</groupId>
    <artifactId>asciidoctorj</artifactId>
   </dependency>
+  <dependency>
+   <groupId>org.apache.httpcomponents</groupId>
+   <artifactId>httpclient</artifactId>
+  </dependency>
 
  <!-- Runtime -->
 

commons/doc-maven-plugin/src/main/java/org/openidentityplatform/doc/maven/AsciidocPreProcessMojo.java

@@ -11,14 +11,19 @@
  * Header, with the fields enclosed by brackets [] replaced by your own identifying
  * information: "Portions copyright [year] [name of copyright owner]".
  *
- * Copyright 2024 3A Systems LLC.
+ * Copyright 2024-2025 3A Systems LLC.
  */
 
 package org.openidentityplatform.doc.maven;
 
 
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.FilenameUtils;
+import org.apache.http.client.methods.CloseableHttpResponse;
+import org.apache.http.client.methods.HttpGet;
+import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.http.impl.client.HttpClients;
+import org.apache.http.util.EntityUtils;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.LifecyclePhase;
@@ -28,13 +33,16 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URL;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.FileSystem;
 import java.nio.file.FileSystems;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.StandardCopyOption;
 import java.util.Collections;
 import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -67,6 +75,11 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             throw new MojoExecutionException("error copying partials content", e);
         }
 
+        copyDocsDirectories();
+        updateVersionAttributes();
+    }
+
+    protected void copyDocsDirectories() throws MojoExecutionException {
         for(File docDir : getAsciidocSourceDirectory().listFiles()) {
             String document = FilenameUtils.getBaseName(docDir.toString());
 
@@ -84,6 +97,46 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         }
     }
 
+    protected void updateVersionAttributes() {
+        String version;
+        String url = String.format("https://api.github.com/repos/OpenIdentityPlatform/%s/releases/latest", this.projectName);
+        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
+            HttpGet request = new HttpGet(url);
+            try (CloseableHttpResponse response = httpClient.execute(request)) {
+                String responseBody = EntityUtils.toString(response.getEntity());
+                String pattern = "\"name\"\\s*:\\s*\"([^\"]+)\"";
+                Pattern regex = Pattern.compile(pattern);
+                Matcher matcher = regex.matcher(responseBody);
+
+                if (!matcher.find()) {
+                    return;
+                }
+                version = matcher.group(1);
+                setVersion(version);
+            }
+        } catch (Exception e) {
+            getLog().warn("error occurred while getting version", e);
+        }
+    }
+
+    protected void setVersion(String version) throws IOException {
+        String versionShort = version.replaceAll("(\\.\\d+)(?!.*\\d)", "");
+        for(File docDir : getSourceOutputDirectory().listFiles()) {
+            System.out.println(docDir);
+            for(File docFile : docDir.listFiles((dir, name) -> name.toLowerCase().endsWith(".adoc"))) {
+                System.out.println(docFile);
+                String adoc = FileUtils.readFileToString(docFile, StandardCharsets.UTF_8);
+                String versionRegex = String.format("(:%s-version:)\\s*(.*)\\b", this.projectName.toLowerCase());
+                adoc = adoc.replaceAll(versionRegex, "$1 " + version);
+
+                String versionShortRegex = String.format("(:%s-version-short:)\\s*(.*)\\b", this.projectName);
+                adoc = adoc.replaceAll(versionShortRegex, "$1 " + versionShort);
+
+                FileUtils.writeStringToFile(docFile, adoc, StandardCharsets.UTF_8);
+            }
+        }
+    }
+
     private void copyResourcesFolder(String resFolder, File outputDir) throws Exception {
         List<Path> files;
         URL partials = getClass().getResource(resFolder);

commons/doc-maven-plugin/src/test/java/org/openidentityplatform/doc/maven/AsciidocPreProcessMojoTest.java

@@ -0,0 +1,58 @@
+/*
+ * The contents of this file are subject to the terms of the Common Development and
+ * Distribution License (the License). You may not use this file except in compliance with the
+ * License.
+ *
+ * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
+ * specific language governing permission and limitations under the License.
+ *
+ * When distributing Covered Software, include this CDDL Header Notice in each file and include
+ * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
+ * Header, with the fields enclosed by brackets [] replaced by your own identifying
+ * information: "Portions copyright [year] [name of copyright owner]".
+ *
+ * Copyright 2025 3A Systems LLC.
+ */
+
+package org.openidentityplatform.doc.maven;
+
+import org.apache.maven.plugin.testing.AbstractMojoTestCase;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.io.File;
+import java.nio.file.Files;
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class AsciidocPreProcessMojoTest extends AbstractMojoTestCase {
+    @Before
+    public void setUp() throws Exception {
+        super.setUp();
+    }
+
+    @After
+    public void tearDown() throws Exception {
+        super.tearDown();
+    }
+
+    @Test
+    public void testExecute() throws Exception {
+        File pom = getTestFile("src/test/resources/antora/pom.xml");
+        assertThat(pom).isNotNull();
+
+        AsciidocPreProcessMojo asciidocPreProcessMojo = (AsciidocPreProcessMojo) lookupMojo("asciidoc-pre-process", pom);
+        assertThat(asciidocPreProcessMojo).isNotNull();
+        this.configureMojo(asciidocPreProcessMojo, "doc-maven-plugin", pom);
+        Map<String, Object> params = this.getVariablesAndValuesFromObject(asciidocPreProcessMojo);
+        System.out.println(params);
+
+        Files.createDirectories(asciidocPreProcessMojo.getSourceOutputPartialsDirectory().toPath());
+        asciidocPreProcessMojo.copyDocsDirectories();
+
+        asciidocPreProcessMojo.updateVersionAttributes();
+    }
+
+}

commons/doc-maven-plugin/src/test/resources/antora/pom.xml

@@ -13,7 +13,7 @@
  * information: "Portions copyright [year] [name of copyright owner]".
  *
  * Copyright 2014 ForgeRock AS
- * Portions copyright 2024 3A Systems LLC.
+ * Portions copyright 2024-2025 3A Systems LLC.
 -->
 <project xmlns="http://maven.apache.org/POM/4.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -32,24 +32,25 @@
     <artifactId>doc-maven-plugin</artifactId>
 
     <configuration>
-     <projectName>Test</projectName>
+     <projectName>commons</projectName>
      <projectVersion>1.0.0-SNAPSHOT</projectVersion>
      <releaseVersion>1.0.0</releaseVersion>
+     <asciidocSourceDirectory>${basedir}/src/test/resources/asciidoc</asciidocSourceDirectory>
+     <buildDirectory>${basedir}/target/asciidoc-test</buildDirectory>
+     <documents>
+      <document>reference</document>
+      <document>admin-guide</document>
+     </documents>
     </configuration>
 
     <executions>
      <execution>
       <id>antora-doc-build</id>
       <phase>site</phase>
       <goals>
+       <goal>asciidoc-pre-process</goal>
        <goal>antora</goal>
       </goals>
-      <configuration>
-       <documents>
-        <document>gateway-guide</document>
-        <document>admin-guide</document>
-       </documents>
-     </configuration>
      </execution>
     </executions>
    </plugin>

commons/doc-maven-plugin/src/test/resources/asciidoc/admin-guide/index.adoc

@@ -0,0 +1,21 @@
+////
+  The contents of this file are subject to the terms of the Common Development and
+  Distribution License (the License). You may not use this file except in compliance with the
+  License.
+
+  You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
+  specific language governing permission and limitations under the License.
+
+  When distributing Covered Software, include this CDDL Header Notice in each file and include
+  the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
+  Header, with the fields enclosed by brackets [] replaced by your own identifying
+  information: "Portions copyright [year] [name of copyright owner]".
+  Copyright 2025 3A Systems LLC.
+////
+
+= Administration Guide
+:doctype: book
+:commons-version: 0.1.1
+:commons-version-short: 0.1
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

commons/doc-maven-plugin/src/test/resources/asciidoc/reference/ch02.adoc

@@ -0,0 +1,20 @@
+////
+  The contents of this file are subject to the terms of the Common Development and
+  Distribution License (the License). You may not use this file except in compliance with the
+  License.
+
+  You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
+  specific language governing permission and limitations under the License.
+
+  When distributing Covered Software, include this CDDL Header Notice in each file and include
+  the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
+  Header, with the fields enclosed by brackets [] replaced by your own identifying
+  information: "Portions copyright [year] [name of copyright owner]".
+  Copyright 2025 3A Systems LLC.
+////
+
+:commons-version: 0.1.1
+
+== Chapter 2
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

commons/doc-maven-plugin/src/test/resources/asciidoc/reference/index.adoc

@@ -0,0 +1,22 @@
+////
+  The contents of this file are subject to the terms of the Common Development and
+  Distribution License (the License). You may not use this file except in compliance with the
+  License.
+
+  You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
+  specific language governing permission and limitations under the License.
+
+  When distributing Covered Software, include this CDDL Header Notice in each file and include
+  the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
+  Header, with the fields enclosed by brackets [] replaced by your own identifying
+  information: "Portions copyright [year] [name of copyright owner]".
+  Copyright 2025 3A Systems LLC.
+////
+
+= Reference
+:doctype: book
+:commons-version: 0.1.1
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+include::./ch02.adoc[]