[logging-log4j-kotlin] branch master updated: LOG4J2-3400 Add page about Maven, Ivy and Gradle artifacts

[gr...@apache.org]

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

grobmeier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4j-kotlin.git


The following commit(s) were added to refs/heads/master by this push:
     new ba948ee  LOG4J2-3400 Add page about Maven, Ivy and Gradle artifacts
     new fbff00d  Merge pull request #23 from breun/feature/LOG4J2-3400
ba948ee is described below

commit ba948ee0cb3f28009ea1c0740fc22993a2639a0b
Author: Nils Breunese <ni...@breun.nl>
AuthorDate: Sun Feb 13 19:09:18 2022 +0100

    LOG4J2-3400 Add page about Maven, Ivy and Gradle artifacts
---
 src/site/asciidoc/artifacts.adoc | 102 +++++++++++++++++++++++++++++++++++++++
 src/site/site.xml                |   1 +
 2 files changed, 103 insertions(+)

diff --git a/src/site/asciidoc/artifacts.adoc b/src/site/asciidoc/artifacts.adoc
new file mode 100644
index 0000000..aa65fd9
--- /dev/null
+++ b/src/site/asciidoc/artifacts.adoc
@@ -0,0 +1,102 @@
+////
+    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.
+////
+= Maven, Ivy, and Gradle Artifacts
+
+Log4j is broken up in an API and an implementation (core),
+where the API provides the interface that applications should code to.
+Log4j core is only needed at runtime and not at compile time.
+
+== Using Log4j Kotlin in your Apache Maven build
+
+To build with https://maven.apache.org/[Apache Maven], add the dependencies listed below to your `pom.xml` file.
+
+.pom.xml
+[source,xml]
+----
+<dependencies>
+  <dependency>
+    <groupId>org.apache.logging.log4j</groupId>
+    <artifactId>log4j-api-kotlin</artifactId>
+    <version>1.3.0-SNAPSHOT</version>
+  </dependency>
+</dependencies>
+----
+<1>
+
+== Using Log4j Kotlin in your Apache Ivy build
+
+To build with https://ant.apache.org/ivy/[Apache Ivy], add the dependencies listed below to your
+`ivy.xml` file.
+
+.ivy.xml
+[source,xml]
+----
+<dependencies>
+  <dependency org="org.apache.logging.log4j" name="log4j-api-kotlin" rev="1.3.0-SNAPSHOT" />
+</dependencies>
+----
+
+== Using Log4j in your Gradle build
+
+To build with https://gradle.org/[Gradle], add the dependencies listed below to your `build.gradle` file.
+
+.build.gradle
+[source]
+----
+dependencies {
+  compile group: 'org.apache.logging.log4j', name: 'log4j-api-kotlin', version: '1.3.0-SNAPSHOT'
+}
+----
+
+== Snapshot builds
+
+You can access the latest development snapshot by using the Maven repository https://repository.apache.org/snapshots and the current SNAPSHOT version.
+Generally, the master branch will use the next patch version as its snapshot version regardless of what the next actual version of Log4j Kotlin will be.
+For example, if the latest release were 1.1.0, then master would be using the version 1.2.0-SNAPSHOT.
+Always verify with `pom.xml` in the master branch as described in the source repository.
+
+=== Maven
+
+Maven users can add the following to their `pom.xml` to enable snapshots:
+
+.pom.xml
+[source,xml]
+----
+<repositories>
+  <repository>
+    <id>apache.snapshots</id>
+    <name>Apache Snapshot Repository</name>
+    <url>https://repository.apache.org/snapshots</url>
+    <releases>
+      <enabled>false</enabled>
+    </releases>
+  </repository>
+</repositories>
+----
+
+=== Gradle
+
+Gradle users can add the following to their `build.gradle` to enable snapshots:
+
+.build.gradle
+[source]
+----
+repositories {
+  mavenCentral()
+  maven { url 'https://repository.apache.org/snapshots' }
+}
+----
\ No newline at end of file
diff --git a/src/site/site.xml b/src/site/site.xml
index c603a94..c4d3b4b 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -29,6 +29,7 @@
 
     <menu name="Apache Log4j Kotlin" inherit="top" img="icon-home">
       <item name="About" href="/index.html"/>
+      <item name="Maven, Ivy, and Gradle Artifacts" href="/artifacts.html"/>
       <item name="Download" href="/download.html"/>
       <item name="Usage" href="/usage.html"/>
     </menu>