You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@logging.apache.org by GitBox <gi...@apache.org> on 2021/10/19 21:08:11 UTC

[GitHub] [logging-log4j-tools] rgoers commented on a change in pull request #2: Initial migration of maven-shaded-log4j-transformer

rgoers commented on a change in pull request #2:
URL: https://github.com/apache/logging-log4j-tools/pull/2#discussion_r732242689



##########
File path: log4j-maven-plugins/log4j-maven-plugins-shade-transformer/src/site/markdown/index.md
##########
@@ -0,0 +1,81 @@
+<!-- vim: set syn=markdown : -->

Review comment:
       In master we still use markdown for all the site descriptors just like this is doing. Event Json Template Layout does.

##########
File path: log4j-maven-plugins/log4j-maven-plugins-shade-transformer/src/site/markdown/index.md
##########
@@ -0,0 +1,81 @@
+<!-- vim: set syn=markdown : -->
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+# Log4j Maven Shaded Plugin Support
+
+This module provides support for [Apache Maven Shade Plugin](https://maven.apache.org/plugins/maven-shade-plugin/). 
+
+## Overview
+
+This module includes the transformer for [Apache Maven Shade Plugin](https://maven.apache.org/plugins/maven-shade-plugin/), that concatenates `Log4j2Plugins.dat` files,

Review comment:
       a) the comments can be improved after the PR is pushed.  b) There is no Log4j 3. It will be Log4j 2 3.0

##########
File path: log4j-maven-plugins/log4j-maven-plugins-shade-transformer/src/site/site.xml
##########
@@ -0,0 +1,52 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+-->
+<project name="Log4j Maven Shade Plugin Transformer"
+         xmlns="http://maven.apache.org/DECORATION/1.4.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/DECORATION/1.4.0 http://maven.apache.org/xsd/decoration-1.4.0.xsd">
+  <body>
+    <links>
+      <item name="Apache" href="http://www.apache.org/" />
+      <item name="Logging Services" href="http://logging.apache.org/"/>
+      <item name="Log4j" href="../index.html"/>

Review comment:
       Whether it is correct or not depends on where the site gets deployed. I suspect it almost certainly is not correct and should used the full url to the Log4j site. But we can fix that in a subsequent commit.

##########
File path: log4j-maven-plugins/log4j-maven-plugins-shade-transformer/pom.xml
##########
@@ -0,0 +1,233 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<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>
+  <parent>
+    <groupId>org.apache.logging.maven</groupId>
+    <artifactId>log4j-maven-plugins</artifactId>
+    <version>2.14.1-SNAPSHOT</version>
+    <relativePath>../</relativePath>
+  </parent>
+  <artifactId>log4j-maven-plugins-shade-transformer</artifactId>

Review comment:
       Typically, the groupId is org.apache.logging.log4j for everything related to log4j. I'm not sure we need the maven distinction on the groupId.
   I am fine with the package name being org.apache.logging.log4j.maven. 
   I am fine with the artifactId. The module should be the same (which it is).
   I am fine with nesting this plugin under log4j-maven-plugins. Although we may never have another Maven plugin I see no reason to preclude it.
   
   This jar doesn't need JPMS support. It is a jar to be added to the maven shade plugin, which doesn't rely on JPMS (thank goodness). That said, the package name should not overlap any other potential maven plugins, so the full package name of org.apache.logging.log4j.maven.shaded.transformer is correct, unless we decide that "shade" should be used everywhere.
   
   
   




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@logging.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org