Skip to content

cleanup changes for Antora #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 16, 2025
Merged

cleanup changes for Antora #238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df53f98
cleanup changes for Antora
FreeAndNil Apr 15, 2025
c96c13b
implemented code review suggestions
FreeAndNil Apr 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions antora-playbook.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,9 @@ ui:
<span class="navbar-item title">{{site.title}}</span>
</div>
<div id="topbar-nav" class="navbar-menu">
<div class="navbar-end">
<a class="navbar-item" href="https://github.com/apache/logging-log4net">GitHub</a>
</div>
<div class="navbar-end">
<a class="navbar-item" href="https://logging.apache.org">a subproject of&nbsp;<strong>Apache Logging Services</strong></a>
</div>
Expand Down
108 changes: 2 additions & 106 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<parent>
<groupId>org.apache.logging</groupId>
<artifactId>logging-parent</artifactId>
<version>11.0.0</version>
<version>12.1.0</version>
</parent>

<packaging>pom</packaging>
Expand Down Expand Up @@ -65,116 +65,12 @@
</ciManagement>

<properties>

<!-- project version -->
<revision>0.10.0-SNAPSHOT</revision>

<!-- `project.build.outputTimestamp` is required to be present for reproducible builds.
We actually inherit one from the `org.apache:apache` through our parent `org.apache.logging:logging-parent`.
Though inheriting this property has two undesired consequences:
1. `artifact:compare` dumps an `ERROR` log stating that this `property should not be inherited but defined` (apache/logging-parent#50)
2. This value is employed in various places while creating the distribution
To mitigate these, we define a *dummy* value here and let the CI replace it during a release.
Hence, *DO NOT MANUALLY EDIT THIS VALUE*! -->
<project.build.outputTimestamp>2024-05-09T11:40:45Z</project.build.outputTimestamp>

<!-- disable `maven-site-plugin`-->
<maven.site.skip>true</maven.site.skip>
<maven.site.deploy.skip>true</maven.site.deploy.skip>
<spotbugs.skip>true</spotbugs.skip>
<revision>3.1.0-SNAPSHOT</revision>
</properties>

<!-- `dependencyManagement` must only contain `log4j-tools` modules and nothing else!
Modules here must have a corresponding entry in `modules` block above! -->
<dependencyManagement>
<dependencies>

<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-changelog</artifactId>
<version>${project.version}</version>
</dependency>

<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-docgen</artifactId>
<version>${project.version}</version>
</dependency>

<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-docgen-asciidoctor-extension</artifactId>
<version>${project.version}</version>
</dependency>

</dependencies>
</dependencyManagement>

<build>
<plugins>

<!-- Enable BOM flattening -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>flatten-maven-plugin</artifactId>
<version>${flatten-maven-plugin.version}</version>
<executions>
<execution>
<id>flatten-bom</id>
<goals>
<goal>flatten</goal>
</goals>
<phase>process-resources</phase>
<inherited>false</inherited>
</execution>
</executions>
</plugin>

<!-- *Temporarily* override the changelog entry file validation inherited from `logging-parent`.

Inherited `validate-changelog` execution explicitly fixes the `log4j-changelog` namespace and schema location.
This makes it impossible to upgrade changelog entry file schemas to a newer version than the one expected by `logging-parent`.

TODO: This will probably be fixed in `logging-parent` version `11.0.0` release.
Hence, from then on, this `xml-maven-plugin` override can be removed. -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>xml-maven-plugin</artifactId>
<executions>
<execution>
<id>validate-changelog</id>
<configuration combine.self="override">
<validationSets>
<validationSet>
<dir>src/changelog</dir>
<includes>
<include>**/*.xml</include>
</includes>
<validating>true</validating>
</validationSet>
</validationSets>
</configuration>
</execution>
</executions>
</plugin>

<plugin>
<groupId>com.diffplug.spotless</groupId>
<artifactId>spotless-maven-plugin</artifactId>
<configuration>
<formats>
<format>
<excludes>
<exclude>**/.idea/*</exclude>
<exclude>src/changelog/**/*.xml</exclude>
<exclude>**/bin/**/*.xml</exclude>
<exclude>**/*.y*ml</exclude>
</excludes>
</format>
</formats>
</configuration>
</plugin>

<plugin>
<groupId>org.apache.rat</groupId>
<artifactId>apache-rat-plugin</artifactId>
Expand Down
6 changes: 3 additions & 3 deletions src/site/antora/antora.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ version: ~
start_page: index.adoc
asciidoc:
attributes:
project-github-url: "https://github.com/apache/logging-log4j-tools"
project-github-url: "https://github.com/apache/logging-log4net"
project-version: "1.2.3"
project-name: "Log4j Tools"
project-id: "log4j-tools"
project-name: "log4net"
project-id: "log4net"
java-target-version: "8"
java-compiler-version: "[17,18)"
logging-services-url: "https://logging.apache.org"
Expand Down