Skip to content
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

Jump to bottom

two other systems + github action artifact generation. #6

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

two other systems + github action artifact generation. #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b779348
Added tinylog as mentioned on https://en.wikipedia.org/wiki/SLF4J
ravn Sep 27, 2022
ec6e607
Merge remote-tracking branch 'origin/main'
ravn Oct 1, 2022
c49137e
Added log4j v2 and jboss logging under Others. Save generated site a…
ravn Oct 1, 2022
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
30 changes: 30 additions & 0 deletions .github/workflows/maven.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven

name: Java CI with Maven

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
cache: maven
- name: Build with Maven
run: mvn -B install --file pom.xml
- uses: actions/upload-artifact@v3
with:
name: sfl4j-site
path: target/site/
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ The command for "building" the site contents is:

This copies html files from `src/site/pages/` folder to `target/site/` folder, performing variable replacements along the way.

The local version of the website can then be navigated on your local machine
at `target/site/`.
The local version of the website can then be navigated at
[target/site/index.html](target/site/index.html)
8 changes: 3 additions & 5 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion>

<groupId>org.slf4j</groupId>
<version>2.0.3</version>
<version>2.0.1</version>
<artifactId>slf4j-site</artifactId>

<!-- is not intended for deployment on Maven central -->
Expand All @@ -18,12 +18,10 @@
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<latest.1.version>1.7.36</latest.1.version>
<latest.2.version>2.0.3</latest.2.version>
<latest.2.version>2.0.1</latest.2.version>
<latest.stable.version>${latest.2.version}</latest.stable.version>
<older.stable.version>${latest.1.version}</older.stable.version>
<logback-javax.version>1.3.2</logback-javax.version>
<logback-jakarta.version>1.4.2</logback-jakarta.version>
<reload4j.version>1.2.22</reload4j.version>

<maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
<maven-site-plugin.version>3.7.1</maven-site-plugin.version>
<maven-resources-plugin.version>3.1.0</maven-resources-plugin.version>
Expand Down
8 changes: 4 additions & 4 deletions src/site/pages/codes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,13 @@ <h3 class="doAnchor" name="ignoredBindings">Class path contains

<p>In case SLF4J finds no providers targeting SLF4J 2.0.x but finds
instead bindings targeting SLF4J 1.7 or earlier, it will list the
bindings it finds but otherwise will <b>ignore</b> them.
bindings it finds but otherwise <b>ignores</b> them.
</p>

<p>This can be solved by placing an SLF4J provider on your
classpath, such providers include logback version <b>1.3.x</b> and
later, as well as one of slf4j-reload4j, slf4j-jdk14, slf4j-simple
version 2.0.0 or later. </p>
classpath, such providers include logback 1.3.x and later, as well as
&lcub; slf4j-reload4j, slf4j-jdk14, slf4j-simple &rcub; versions 2.0.0
or later.</p>

<p>See also the FAQ
entry <a href="faq.html#changesInVersion200">What has changed in
Expand Down
31 changes: 24 additions & 7 deletions src/site/pages/css/site.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,9 @@ dd {
*/
/* ------------------------------------ */

.anchor { display:none; }


h1, h2, h3, h4 {
color: #505050;
padding-top: 0ex;
Expand All @@ -231,12 +234,26 @@ h4 {
font-size: medium;
}

h1 .anchor:before,
h2 .anchor:before,
h3 .anchor:before,
h4 .anchor:before,
td .anchor:before {content: "\01f517"; display: inline-block; margin-right: 1ex;}

h1 .anchor:before {content:url(anchor24.png);}
h2 .anchor:before {content:url(anchor20.png);}
h3 .anchor:before {content:url(anchor16.png);}
h4 .anchor:before {content:url(anchor12.png);}
td .anchor:before {content:url(anchor12.png);}

h1:hover .anchor { margin-left: -24px; }
h2:hover .anchor { margin-left: -20px; }
h3:hover .anchor { margin-left: -16px; }
h4:hover .anchor { margin-left: -12px; }
td:hover .anchor { margin-left: -12px; }

h1:hover .anchor,
h2:hover .anchor,
h3:hover .anchor,
h4:hover .anchor,
td:hover .anchor {
display: inline-block;
text-decoration: none;
}


div.source {
Expand Down Expand Up @@ -449,7 +466,7 @@ code {
/** ----------- labels -------- */
.label {
padding: 1px 3px 2px;
xfont-size: 12px;
font-size: 9.75px;
font-weight: bold;
color: #ffffff;
text-transform: uppercase;
Expand Down
2 changes: 1 addition & 1 deletion src/site/pages/download.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ <h2>Maven central</h2>
<p>SLF4J artifacts such as <em>.jar</em>, <em>.sources.jar</em>
and <em>javadoc.jar</em> files can be downloaded from <a
href="https://repo1.maven.org/maven2/org/slf4j/">Maven
central</a>. The corresponding groupId is <code class="big">org.slf4j</code>.</p>
central</a>. The corresponding groupId is <code>org.slf4j</code>.</p>

<h2>Verifying contents</h2>

Expand Down
2 changes: 1 addition & 1 deletion src/site/pages/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@


<h2>Simple Logging Facade for Java (SLF4J)</h2>

<p>The Simple Logging Facade for Java (SLF4J) serves as a simple
facade or abstraction for various logging frameworks
(e.g. java.util.logging, logback, log4j) allowing the end user to
Expand Down
144 changes: 25 additions & 119 deletions src/site/pages/manual.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
<div id="content">



<h2>SLF4J user manual</h2>

<p>The Simple Logging Facade for Java (SLF4J) serves as a simple
Expand All @@ -38,14 +37,6 @@ <h2>SLF4J user manual</h2>
the addition of only a single mandatory dependency, namely
<em>slf4j-api-${latest.stable.version}.jar</em>.</p>

<h3 class="doAnchor" name="where_coordinates">Where are the Maven coordinates?</h3>

<p>At this time if you are only interested in obtaining the
coordinates for using SLF4J API with a logging backend, you can <a
href="#projectDep">jump to the relevant section</a>.</p>

<h3 class="doAnchor" name="salient_changes">Salient historical changes</h3>

<p><span class="label">since 1.6.0</span> If no binding is found on the
class path, then SLF4J will default to a no-operation
implementation.
Expand Down Expand Up @@ -303,13 +294,11 @@ <h3 class="doAnchor" name="swapping">Binding with a logging

<dt><em>slf4j-reload4j-${latest.stable.version}.jar</em>
</dt>
<dd>
<p><span class="label notice">since 1.7.33</span>
Binding/provider for <a
href="http://reload4j.qos.ch">reload4j</a>
framework. Reload4j is a drop-in replacement for log4j
version 1.2.7. You also need to place <em>reload4j.jar</em>
on your class path.</p>
<dd><span class="label notice">since 1.7.33</span> Binding/provider for
<a href="http://reload4j.qos.ch">reload4j</a>
framework. Reload4j is a drop-in replacement for log4j version
1.2.7. You also need to place <em>reload4j.jar</em> on your
class path.</p>


<dt><em>slf4j-jdk14-${latest.stable.version}.jar</em> </dt>
Expand Down Expand Up @@ -337,14 +326,7 @@ <h3 class="doAnchor" name="swapping">Binding with a logging
JCL.<p/>
</dd>

<dt>
<em>logback-classic-${logback-jakarta.version}.jar for use with Jakarta EE, requires logback-core-${logback-jakarta.version}.jar</em>
<br/>
or
<br/>
<em>logback-classic-${logback-javax.version}.jar for use with Javax EE, requires logback-core-${logback-javax.version}.jar</em>

</dt>
<dt><em>logback-classic-${logback.version}.jar (requires logback-core-${logback.version}.jar)</em></dt>

<dd><span class="label notice">Native implementation</span> There are also
SLF4J bindings/providers external to the SLF4J project, e.g. <a
Expand Down Expand Up @@ -469,86 +451,32 @@ <h3 class="doAnchor" name="projectDep">Declaring project
declaration.
</p>

<!-- ========================================================= -->

<p><span class="label notice">SLF4J API</span> SLF4J API ships
within the "org.slf4j:slf4j-api" artifact. You can explicitly
declare a dependency to it in your <em>pom.xml</em> file as
shown below. Note that most logging implementations will
automatically pull-in slf4j-api as a dependency. However, it is
often a good idea to declare an explicit dependency to slf4j-api
in order to fix the correct version of slf4j-api your project by
virtue of of Maven's "nearest definition" dependency mediation
<p><span class="label notice">logback-classic</span> If you wish
to use logback-classic as the underlying logging framework, all
you need to do is to declare "ch.qos.logback:logback-classic" as
a dependency in your <em>pom.xml</em> file as shown below. In
addition to <em>logback-classic-${logback.version}.jar</em>,
this will pull in
<em>slf4j-api-${latest.stable.version}.jar</em> as well as
<em>logback-core-${logback.version}.jar</em> into your
project. Note that explicitly declaring a dependency on
<em>logback-core-${logback.version}</em> or
<em>slf4j-api-${latest.stable.version}.jar</em> is not wrong and
may be necessary to impose the correct version of said artifacts
by virtue of Maven's "nearest definition" dependency mediation
rule.
</p>


<pre class="prettyprint source">&lt;dependency>
&lt;groupId>org.slf4j&lt;/groupId>
&lt;artifactId>slf4j-api&lt;/artifactId>
&lt;version>${latest.stable.version}&lt;/version>
&lt;/dependency></pre>

<!-- ========================================================= -->
<p><span class="label notice">logback-classic</span> <span
class="label notice big">1.3.x</span> <span class="label">(Javax
EE)</span> If you wish to use logback-classic for <span
class="green big">Javax EE</span> as the underlying logging
framework, all you need to do is to declare
"ch.qos.logback:logback-classic" as a dependency in your
<em>pom.xml</em> file as shown below. In addition to
<em>logback-classic-${logback-javax.version}.jar</em>, this will
pull in <em>slf4j-api-${latest.stable.version}.jar</em> as well
as <em>logback-core-${logback-javax.version}.jar</em> into your
project. Note that explicitly declaring a dependency on
<em>logback-core-${logback-javax.version}</em> or
<em>slf4j-api-${latest.stable.version}.jar</em> is not wrong and
may be necessary to impose the correct version of said artifacts
by virtue of Maven's "nearest definition" dependency mediation
rule.
</p>

<pre class="prettyprint source">&lt;dependency>
&lt;groupId>ch.qos.logback&lt;/groupId>
&lt;artifactId>logback-classic&lt;/artifactId>
&lt;version>${logback-javax.version}&lt;/version>
&lt;/dependency></pre>

<p/>

<!-- ================================== -->

<p><span class="label notice">logback-classic</span>
<span class="label notice big">1.4.x</span>
<span class="label">(Jakarta EE)</span>

If you wish to use logback-classic for <span class="big
green">Jakarta EE</span> as the underlying logging framework,
all you need to do is to declare
"ch.qos.logback:logback-classic" as a dependency in your
<em>pom.xml</em> file as shown below. In addition to
<em>logback-classic-${logback-jakarta.version}.jar</em>, this
will pull in <em>slf4j-api-${latest.stable.version}.jar</em> as
well as <em>logback-core-${logback-jakarta.version}.jar</em>
into your project. Note that <em>explicitly</em> declaring a
dependency on <em>logback-core-${logback-jakarta.version}</em>
or <em>slf4j-api-${latest.stable.version}.jar</em> is not wrong
and may be necessary to impose the correct version of said
artifacts by virtue of Maven's "nearest definition" dependency
mediation rule.
</p>

<pre class="prettyprint source">&lt;dependency>
&lt;groupId>ch.qos.logback&lt;/groupId>
&lt;artifactId>logback-classic&lt;/artifactId>
&lt;version>${logback-jakarta.version}&lt;/version>
&lt;version>${logback.version}&lt;/version>
&lt;/dependency></pre>

<p/>

<!-- ================================== -->

<p><span class="label notice">reload4j</span> If you wish to use
<p><span class="label notice">reload4j</span> If you wish to use
reload4j as the underlying logging framework, all you need to do
is to declare "org.slf4j:slf4j-reload4j" as a dependency in your
<em>pom.xml</em> file as shown below. In addition to
Expand All @@ -571,11 +499,10 @@ <h3 class="doAnchor" name="projectDep">Declaring project

<!-- ================================== -->

<p><span class="label notice">log4j 1.2.x</span> As of SLF4J
version 1.7.36, declaring a dependency on
<code>org.slf4j:slf4j-log4j12</code> redirects to
<code>org.slf4j:slf4j-reload4j</code> by virtue of Maven
&lt;relocation&gt; directive. </p>
<p><span class="label notice">log4j</span> As of version 1.7.35,
declaring a dependency on <code>org.slf4j:slf4j-log4j12</code>
redirects to <code>org.slf4j:slf4j-reload4j</code> by virtue of
Maven &lt;relocation&gt; directive. </p>

<pre class="prettyprint source">&lt;dependency>
&lt;groupId>org.slf4j&lt;/groupId>
Expand Down Expand Up @@ -606,28 +533,7 @@ <h3 class="doAnchor" name="projectDep">Declaring project
&lt;version>${latest.stable.version}&lt;/version>
&lt;/dependency></pre>

<!-- ================================== -->

<p><span class="label notice">SLF4J Simple</span> If you
wish to use org.slf4j.simple as the underlying logging
implementation, all you need to do is to declare
"org.slf4j:slf4j-simple" as a dependency in your <em>pom.xml</em>
file as shown below. In addition to
<em>slf4j-simple-${latest.stable.version}.jar</em>, this will
pull in <em>slf4j-api-${latest.stable.version}.jar</em> into
your project. Note that explicitly declaring a dependency on
<em>slf4j-api-${latest.stable.version}.jar</em> is not wrong and
may be necessary to impose the correct version of said artifact
by virtue of Maven's "nearest definition" dependency mediation
rule.</p>

<pre class="prettyprint source">&lt;dependency>
&lt;groupId>org.slf4j&lt;/groupId>
&lt;artifactId>slf4j-simple&lt;/artifactId>
&lt;version>${latest.stable.version}&lt;/version>
&lt;/dependency></pre>

<!-- =========================================================== -->

<h3 class="doAnchor" name="compatibility">Binary
compatibility</h3>
Expand Down
Loading