Skip to content

Commit a6904ab

Browse files
FreeAndNilFreeAndNil
authored
cleanup changes for Antora (#238)
* cleanup changes for Antora * implemented code review suggestions
1 parent 68b5019 commit a6904ab

File tree

3 files changed

+8
-109
lines changed

3 files changed

+8
-109
lines changed

‎antora-playbook.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,9 @@ ui:
109109
<span class="navbar-item title">{{site.title}}</span>
110110
</div>
111111
<div id="topbar-nav" class="navbar-menu">
112+
<div class="navbar-end">
113+
<a class="navbar-item" href="https://github.com/apache/logging-log4net">GitHub</a>
114+
</div>
112115
<div class="navbar-end">
113116
<a class="navbar-item" href="https://logging.apache.org">a subproject of&nbsp;<strong>Apache Logging Services</strong></a>
114117
</div>

‎pom.xml

Lines changed: 2 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
<parent>
2525
<groupId>org.apache.logging</groupId>
2626
<artifactId>logging-parent</artifactId>
27-
<version>11.0.0</version>
27+
<version>12.1.0</version>
2828
</parent>
2929

3030
<packaging>pom</packaging>
@@ -65,116 +65,12 @@
6565
</ciManagement>
6666

6767
<properties>
68-
6968
<!-- project version -->
70-
<revision>0.10.0-SNAPSHOT</revision>
71-
72-
<!-- `project.build.outputTimestamp` is required to be present for reproducible builds.
73-
We actually inherit one from the `org.apache:apache` through our parent `org.apache.logging:logging-parent`.
74-
Though inheriting this property has two undesired consequences:
75-
1. `artifact:compare` dumps an `ERROR` log stating that this `property should not be inherited but defined` (apache/logging-parent#50)
76-
2. This value is employed in various places while creating the distribution
77-
To mitigate these, we define a *dummy* value here and let the CI replace it during a release.
78-
Hence, *DO NOT MANUALLY EDIT THIS VALUE*! -->
79-
<project.build.outputTimestamp>2024-05-09T11:40:45Z</project.build.outputTimestamp>
80-
81-
<!-- disable `maven-site-plugin`-->
82-
<maven.site.skip>true</maven.site.skip>
83-
<maven.site.deploy.skip>true</maven.site.deploy.skip>
84-
<spotbugs.skip>true</spotbugs.skip>
69+
<revision>3.1.0-SNAPSHOT</revision>
8570
</properties>
8671

87-
<!-- `dependencyManagement` must only contain `log4j-tools` modules and nothing else!
88-
Modules here must have a corresponding entry in `modules` block above! -->
89-
<dependencyManagement>
90-
<dependencies>
91-
92-
<dependency>
93-
<groupId>org.apache.logging.log4j</groupId>
94-
<artifactId>log4j-changelog</artifactId>
95-
<version>${project.version}</version>
96-
</dependency>
97-
98-
<dependency>
99-
<groupId>org.apache.logging.log4j</groupId>
100-
<artifactId>log4j-docgen</artifactId>
101-
<version>${project.version}</version>
102-
</dependency>
103-
104-
<dependency>
105-
<groupId>org.apache.logging.log4j</groupId>
106-
<artifactId>log4j-docgen-asciidoctor-extension</artifactId>
107-
<version>${project.version}</version>
108-
</dependency>
109-
110-
</dependencies>
111-
</dependencyManagement>
112-
11372
<build>
11473
<plugins>
115-
116-
<!-- Enable BOM flattening -->
117-
<plugin>
118-
<groupId>org.codehaus.mojo</groupId>
119-
<artifactId>flatten-maven-plugin</artifactId>
120-
<version>${flatten-maven-plugin.version}</version>
121-
<executions>
122-
<execution>
123-
<id>flatten-bom</id>
124-
<goals>
125-
<goal>flatten</goal>
126-
</goals>
127-
<phase>process-resources</phase>
128-
<inherited>false</inherited>
129-
</execution>
130-
</executions>
131-
</plugin>
132-
133-
<!-- *Temporarily* override the changelog entry file validation inherited from `logging-parent`.
134-
135-
Inherited `validate-changelog` execution explicitly fixes the `log4j-changelog` namespace and schema location.
136-
This makes it impossible to upgrade changelog entry file schemas to a newer version than the one expected by `logging-parent`.
137-
138-
TODO: This will probably be fixed in `logging-parent` version `11.0.0` release.
139-
Hence, from then on, this `xml-maven-plugin` override can be removed. -->
140-
<plugin>
141-
<groupId>org.codehaus.mojo</groupId>
142-
<artifactId>xml-maven-plugin</artifactId>
143-
<executions>
144-
<execution>
145-
<id>validate-changelog</id>
146-
<configuration combine.self="override">
147-
<validationSets>
148-
<validationSet>
149-
<dir>src/changelog</dir>
150-
<includes>
151-
<include>**/*.xml</include>
152-
</includes>
153-
<validating>true</validating>
154-
</validationSet>
155-
</validationSets>
156-
</configuration>
157-
</execution>
158-
</executions>
159-
</plugin>
160-
161-
<plugin>
162-
<groupId>com.diffplug.spotless</groupId>
163-
<artifactId>spotless-maven-plugin</artifactId>
164-
<configuration>
165-
<formats>
166-
<format>
167-
<excludes>
168-
<exclude>**/.idea/*</exclude>
169-
<exclude>src/changelog/**/*.xml</exclude>
170-
<exclude>**/bin/**/*.xml</exclude>
171-
<exclude>**/*.y*ml</exclude>
172-
</excludes>
173-
</format>
174-
</formats>
175-
</configuration>
176-
</plugin>
177-
17874
<plugin>
17975
<groupId>org.apache.rat</groupId>
18076
<artifactId>apache-rat-plugin</artifactId>

‎src/site/antora/antora.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ version: ~
3838
start_page: index.adoc
3939
asciidoc:
4040
attributes:
41-
project-github-url: "https://github.com/apache/logging-log4j-tools"
41+
project-github-url: "https://github.com/apache/logging-log4net"
4242
project-version: "1.2.3"
43-
project-name: "Log4j Tools"
44-
project-id: "log4j-tools"
43+
project-name: "log4net"
44+
project-id: "log4net"
4545
java-target-version: "8"
4646
java-compiler-version: "[17,18)"
4747
logging-services-url: "https://logging.apache.org"

0 commit comments

Comments
 (0)