Improve repository.

- add kokuwa checkstyle
- add dependabot
- add dependency documentation
- add code owners
- add codeql
- add license badge
This commit is contained in:
Stephan Schnabel 2022-01-25 11:30:00 +01:00
parent f92d80d1a9
commit 5025e207da
Signed by: stephan.schnabel
GPG key ID: E07AF5BA239FE543
7 changed files with 115 additions and 16 deletions

4
.github/CODEOWNERS vendored Normal file
View file

@ -0,0 +1,4 @@
@sschnabe
@wistefan
@rpahli
@fabian-schlegel

15
.github/dependabot.yml vendored Normal file
View file

@ -0,0 +1,15 @@
version: 2
updates:
- package-ecosystem: maven
directory: /
schedule:
interval: daily
ignore:
- dependency-name: ch.qos.logback:logback-classic
update-types: ["version-update:semver-major", "version-update:semver-minor"]
- dependency-name: io.micronaut:micronaut-bom
update-types: ["version-update:semver-major", "version-update:semver-minor"]
- package-ecosystem: github-actions
directory: /
schedule:
interval: daily

27
.github/workflows/codeql.yaml vendored Normal file
View file

@ -0,0 +1,27 @@
name: CodeQL
"on":
workflow_dispatch: {}
push:
branches: [main]
paths: [src/main/java/*.java]
pull_request:
branches: [main]
paths: [src/main/java/*.java]
schedule:
- cron: '0 0 * * 0'
jobs:
codeql:
runs-on: ubuntu-latest
permissions:
security-events: write
actions: read
contents: read
steps:
- uses: actions/checkout@v2
- uses: github/codeql-action/init@v1
with:
languages: java
- uses: github/codeql-action/autobuild@v1
- uses: github/codeql-action/analyze@v1

View file

@ -20,6 +20,7 @@ jobs:
with:
distribution: temurin
java-version: 11
cache: maven
server-id: sonatype-nexus
server-username: SERVER_USERNAME
server-password: SERVER_PASSWORD

View file

@ -6,7 +6,7 @@ name: Snapshot
jobs:
lint-yaml:
yaml:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
@ -15,7 +15,7 @@ jobs:
format: colored
strict: true
lint-markdown:
markdown:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
@ -47,7 +47,7 @@ jobs:
if: failure()
with:
name: surefire
path: '*/target/surefire-reports/*.xml'
path: '**/target/surefire-reports/*.xml'
reporter: java-junit
list-suites: failed
list-tests: failed

View file

@ -1,7 +1,19 @@
# Micronaut Logging support
[![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/kokuwaio/micronaut-logging.svg?label=License)](http://www.apache.org/licenses/)
[![Maven Central](https://img.shields.io/maven-central/v/io.kokuwa.micronaut/micronaut-logging.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.kokuwa.micronaut%22%20AND%20a:%22micronaut-logging%22)
[![CI](https://github.com/kokuwaio/micronaut-logging/actions/workflows/snapshot.yaml/badge.svg)](https://github.com/kokuwaio/micronaut-logging/actions/workflows/snapshot.yaml)
[![CI](https://img.shields.io/github/workflow/status/kokuwaio/micronaut-logging/Snapshot)](https://github.com/kokuwaio/micronaut-logging/actions/workflows/snapshot.yaml)
Include in your `pom.xml`:
```xml
<dependency>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>micronaut-logging</artifactId>
<version>${version.io.kokuwa.micronaut.logging}</version>
<scope>runtime</scope>
</dependency>
```
## Features

64
pom.xml
View file

@ -23,12 +23,12 @@
<developers>
<developer>
<id>stephanschnabel</id>
<id>sschnabe</id>
<name>Stephan Schnabel</name>
<url>https://github.com/stephanschnabel</url>
<url>https://github.com/sschnabe</url>
<email>stephan@grayc.de</email>
<organization>GrayC GmbH</organization>
<organizationUrl>http://grayc.de</organizationUrl>
<organizationUrl>https://grayc.de</organizationUrl>
</developer>
</developers>
@ -73,31 +73,40 @@
<maven.compiler.showDeprecation>true</maven.compiler.showDeprecation>
<maven.compiler.showWarnings>true</maven.compiler.showWarnings>
<maven.test.redirectTestOutputToFile>true</maven.test.redirectTestOutputToFile>
<checkstyle.config.location>checkstyle.xml</checkstyle.config.location>
<checkstyle.suppressions.location>checkstyle-suppression.xml</checkstyle.suppressions.location>
<checkstyle.includeTestSourceDirectory>true</checkstyle.includeTestSourceDirectory>
<!-- ===================================================================== -->
<!-- ============================= Versions ============================== -->
<!-- ===================================================================== -->
<!-- dependencies -->
<version.ch.qos.logback>1.2.10</version.ch.qos.logback>
<version.ch.qos.logback.contrib>0.1.5</version.ch.qos.logback.contrib>
<version.io.micronaut>3.2.6</version.io.micronaut>
<!-- plugins -->
<version.org.apache.maven.plugins.checkstyle>3.1.2</version.org.apache.maven.plugins.checkstyle>
<version.org.apache.maven.plugins.clean>3.1.0</version.org.apache.maven.plugins.clean>
<version.org.apache.maven.plugins.compiler>3.8.1</version.org.apache.maven.plugins.compiler>
<version.org.apache.maven.plugins.compiler>3.9.0</version.org.apache.maven.plugins.compiler>
<version.org.apache.maven.plugins.deploy>3.0.0-M2</version.org.apache.maven.plugins.deploy>
<version.org.apache.maven.plugins.gpg>3.0.1</version.org.apache.maven.plugins.gpg>
<version.org.apache.maven.plugins.install>3.0.0-M1</version.org.apache.maven.plugins.install>
<version.org.apache.maven.plugins.javadoc>3.3.1</version.org.apache.maven.plugins.javadoc>
<version.org.apache.maven.plugins.jar>3.2.1</version.org.apache.maven.plugins.jar>
<version.org.apache.maven.plugins.jar>3.2.2</version.org.apache.maven.plugins.jar>
<version.org.apache.maven.plugins.release>3.0.0-M5</version.org.apache.maven.plugins.release>
<version.org.apache.maven.plugins.resources>3.2.0</version.org.apache.maven.plugins.resources>
<version.org.apache.maven.plugins.source>3.2.1</version.org.apache.maven.plugins.source>
<version.org.apache.maven.plugins.surefire>3.0.0-M5</version.org.apache.maven.plugins.surefire>
<version.org.codehaus.mojo.tidy>1.1.0</version.org.codehaus.mojo.tidy>
<version.org.sonatype.plugins.nexus-staging>1.6.8</version.org.sonatype.plugins.nexus-staging>
<version.com.puppycrawl.tools.checkstyle>9.2.1</version.com.puppycrawl.tools.checkstyle>
<version.io.kokuwa.checkstyle>0.5.6</version.io.kokuwa.checkstyle>
<!-- dependencies -->
<version.ch.qos.logback>1.2.10</version.ch.qos.logback>
<version.ch.qos.logback.contrib>0.1.5</version.ch.qos.logback.contrib>
<version.io.micronaut>3.2.7</version.io.micronaut>
</properties>
@ -191,6 +200,25 @@
<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>${version.org.apache.maven.plugins.checkstyle}</version>
<dependencies>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>${version.com.puppycrawl.tools.checkstyle}</version>
</dependency>
<dependency>
<groupId>io.kokuwa</groupId>
<artifactId>maven-parent</artifactId>
<version>${version.io.kokuwa.checkstyle}</version>
<type>zip</type>
<classifier>checkstyle</classifier>
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
@ -261,7 +289,6 @@
<artifactId>maven-surefire-plugin</artifactId>
<version>${version.org.apache.maven.plugins.surefire}</version>
<configuration>
<redirectTestOutputToFile>true</redirectTestOutputToFile>
<failIfNoTests>true</failIfNoTests>
</configuration>
</plugin>
@ -305,6 +332,19 @@
</executions>
</plugin>
<!-- fail if checkstyle reports problems -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>