(logging-parent) 03/04: Use a separate property to refer to the project version in the website

[vy...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

vy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/logging-parent.git

commit 4877da3882996bf8505fc478aa3fac7ba4c81f9b
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Thu Apr 11 14:26:27 2024 +0200

    Use a separate property to refer to the project version in the website
---
 pom.xml                                                     | 13 +++++++++++++
 src/site/antora/antora.tmpl.yml                             |  3 +--
 .../modules/ROOT/pages/release-instructions-project.adoc    |  6 ++++++
 3 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/pom.xml b/pom.xml
index 2535d2e..6e86620 100644
--- a/pom.xml
+++ b/pom.xml
@@ -242,11 +242,24 @@
     <error-prone.version>2.26.1</error-prone.version>
     <findsecbugs-plugin.version>1.13.0</findsecbugs-plugin.version>
 
+    <!-- site-specific versions -->
+    <!-- We use a separate property than `project.version` to refer to the most recent _published_ version of the project.
+         This will be used in the site and updated automatically by `dependabot`. -->
+    <site-project.version>10.6.0</site-project.version>
+
   </properties>
 
   <dependencyManagement>
     <dependencies>
 
+      <!-- Dummy dependency to trick `dependabot` into updating the `site-project.version` property -->
+      <dependency>
+        <groupId>org.apache.logging</groupId>
+        <artifactId>logging-parent</artifactId>
+        <version>${site-project.version}</version>
+        <type>pom</type>
+      </dependency>
+
       <dependency>
         <groupId>biz.aQute.bnd</groupId>
         <artifactId>biz.aQute.bnd.annotation</artifactId>
diff --git a/src/site/antora/antora.tmpl.yml b/src/site/antora/antora.tmpl.yml
index 8bda3bb..8c344c0 100644
--- a/src/site/antora/antora.tmpl.yml
+++ b/src/site/antora/antora.tmpl.yml
@@ -39,7 +39,7 @@ start_page: index.adoc
 asciidoc:
   attributes:
     project-github-url: "${scm.url}"
-    project-version: "${project.version}"
+    project-version: "${site-project.version}"
     project-name: Logging Parent
     project-id: "logging-parent"
     java-target-version: "${maven.compiler.target}"
@@ -48,4 +48,3 @@ asciidoc:
     site-url: "https://logging.apache.org/{project-id}"
 nav:
   - modules/ROOT/nav.adoc
-  - modules/manual/nav.adoc
diff --git a/src/site/antora/modules/ROOT/pages/release-instructions-project.adoc b/src/site/antora/modules/ROOT/pages/release-instructions-project.adoc
index 8c43f2c..59f09b0 100644
--- a/src/site/antora/modules/ROOT/pages/release-instructions-project.adoc
+++ b/src/site/antora/modules/ROOT/pages/release-instructions-project.adoc
@@ -47,6 +47,12 @@ git checkout -B release/7.8.0 origin/main
 
 . Prepare sources for the release:
 .. Update the `revision` property in `pom.xml`
++
+[IMPORTANT]
+====
+If your project refers to its own version in the site sources, those need to be updated too.
+For instance, `site-project.version` needs to be updated for `logging-parent`.
+====
 .. Release the changelog: `./mvnw -N changelog-release`
 .. Edit the release notes (i.e., `src/changelog/7.8.0/.release-notes.adoc.ftl`)