Improve repository.
- add kokuwa checkstyle - add dependabot - add dependency documentation - add code owners - add codeql - add license badge
This commit is contained in:
parent
f92d80d1a9
commit
da9cc4d90f
7 changed files with 111 additions and 13 deletions
4
.github/CODEOWNERS
vendored
Normal file
4
.github/CODEOWNERS
vendored
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
@sschnabe
|
||||||
|
@wistefan
|
||||||
|
@rpahli
|
||||||
|
@fabian-schlegel
|
15
.github/dependabot.yml
vendored
Normal file
15
.github/dependabot.yml
vendored
Normal 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"]
|
||||||
|
- dependency-name: io.micronaut:micronaut-bom
|
||||||
|
update-types: ["version-update:semver-major"]
|
||||||
|
- package-ecosystem: github-actions
|
||||||
|
directory: /
|
||||||
|
schedule:
|
||||||
|
interval: daily
|
26
.github/workflows/codeql.yaml
vendored
Normal file
26
.github/workflows/codeql.yaml
vendored
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
name: CodeQL
|
||||||
|
|
||||||
|
"on":
|
||||||
|
workflow_dispatch: {}
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
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
|
1
.github/workflows/release.yaml
vendored
1
.github/workflows/release.yaml
vendored
|
@ -20,6 +20,7 @@ jobs:
|
||||||
with:
|
with:
|
||||||
distribution: temurin
|
distribution: temurin
|
||||||
java-version: 11
|
java-version: 11
|
||||||
|
cache: maven
|
||||||
server-id: sonatype-nexus
|
server-id: sonatype-nexus
|
||||||
server-username: SERVER_USERNAME
|
server-username: SERVER_USERNAME
|
||||||
server-password: SERVER_PASSWORD
|
server-password: SERVER_PASSWORD
|
||||||
|
|
6
.github/workflows/snapshot.yaml
vendored
6
.github/workflows/snapshot.yaml
vendored
|
@ -6,7 +6,7 @@ name: Snapshot
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
|
|
||||||
lint-yaml:
|
yaml:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
|
@ -15,7 +15,7 @@ jobs:
|
||||||
format: colored
|
format: colored
|
||||||
strict: true
|
strict: true
|
||||||
|
|
||||||
lint-markdown:
|
markdown:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
|
@ -47,7 +47,7 @@ jobs:
|
||||||
if: failure()
|
if: failure()
|
||||||
with:
|
with:
|
||||||
name: surefire
|
name: surefire
|
||||||
path: '*/target/surefire-reports/*.xml'
|
path: '**/target/surefire-reports/*.xml'
|
||||||
reporter: java-junit
|
reporter: java-junit
|
||||||
list-suites: failed
|
list-suites: failed
|
||||||
list-tests: failed
|
list-tests: failed
|
||||||
|
|
14
README.md
14
README.md
|
@ -1,7 +1,19 @@
|
||||||
# Micronaut Logging support
|
# Micronaut Logging support
|
||||||
|
|
||||||
|
[](http://www.apache.org/licenses/)
|
||||||
[](https://search.maven.org/search?q=g:%22io.kokuwa.micronaut%22%20AND%20a:%22micronaut-logging%22)
|
[](https://search.maven.org/search?q=g:%22io.kokuwa.micronaut%22%20AND%20a:%22micronaut-logging%22)
|
||||||
[](https://github.com/kokuwaio/micronaut-logging/actions/workflows/snapshot.yaml)
|
[](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
|
## Features
|
||||||
|
|
||||||
|
|
58
pom.xml
58
pom.xml
|
@ -73,31 +73,40 @@
|
||||||
<maven.compiler.showDeprecation>true</maven.compiler.showDeprecation>
|
<maven.compiler.showDeprecation>true</maven.compiler.showDeprecation>
|
||||||
<maven.compiler.showWarnings>true</maven.compiler.showWarnings>
|
<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 ============================== -->
|
<!-- ============================= 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 -->
|
<!-- 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.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.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.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.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.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.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.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.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.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.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.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>
|
</properties>
|
||||||
|
|
||||||
|
@ -191,6 +200,25 @@
|
||||||
<build>
|
<build>
|
||||||
<pluginManagement>
|
<pluginManagement>
|
||||||
<plugins>
|
<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>
|
<plugin>
|
||||||
<groupId>org.apache.maven.plugins</groupId>
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
<artifactId>maven-clean-plugin</artifactId>
|
<artifactId>maven-clean-plugin</artifactId>
|
||||||
|
@ -261,7 +289,6 @@
|
||||||
<artifactId>maven-surefire-plugin</artifactId>
|
<artifactId>maven-surefire-plugin</artifactId>
|
||||||
<version>${version.org.apache.maven.plugins.surefire}</version>
|
<version>${version.org.apache.maven.plugins.surefire}</version>
|
||||||
<configuration>
|
<configuration>
|
||||||
<redirectTestOutputToFile>true</redirectTestOutputToFile>
|
|
||||||
<failIfNoTests>true</failIfNoTests>
|
<failIfNoTests>true</failIfNoTests>
|
||||||
</configuration>
|
</configuration>
|
||||||
</plugin>
|
</plugin>
|
||||||
|
@ -305,6 +332,19 @@
|
||||||
</executions>
|
</executions>
|
||||||
</plugin>
|
</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>
|
</plugins>
|
||||||
</build>
|
</build>
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue