diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml deleted file mode 100644 index 107c3414e..000000000 --- a/.github/workflows/CI.yml +++ /dev/null @@ -1,42 +0,0 @@ -name: CI - -on: - push: - pull_request: - -jobs: - build: - runs-on: ubuntu-latest - name: Java ${{ matrix.java }} - strategy: - # don't cancel remaining matrix steps on failure - fail-fast: false - matrix: - java: [8, 11, 17] - - steps: - - uses: actions/checkout@v2 - - - name: Set up JDK ${{ matrix.java }} - uses: actions/setup-java@v1 - with: - java-version: ${{ matrix.java }} - - - name: Build - run: | - chmod +x gradlew - ./gradlew assemble --no-daemon - - - name: Test - env: - GH_ACTIONS: true - run: ./gradlew check --no-daemon - - - name: Build coverage report - run: ./gradlew jacocoTestReport --no-daemon - - - uses: codecov/codecov-action@v2 - with: - files: build/reports/jacoco/test/jacocoTestReport.xml - flags: LINUX - fail_ci_if_error: true \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index a12d1f77d..000000000 --- a/README.md +++ /dev/null @@ -1,265 +0,0 @@ -# Dropwizard guice integration -[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://www.opensource.org/licenses/MIT) -[![CI](https://github.com/xvik/dropwizard-guicey/actions/workflows/CI.yml/badge.svg)](https://github.com/xvik/dropwizard-guicey/actions/workflows/CI.yml) -[![Appveyor build status](https://ci.appveyor.com/api/projects/status/github/xvik/dropwizard-guicey?svg=true&branch=master)](https://ci.appveyor.com/project/xvik/dropwizard-guicey) -[![codecov](https://codecov.io/gh/xvik/dropwizard-guicey/branch/master/graph/badge.svg)](https://codecov.io/gh/xvik/dropwizard-guicey) - -**DOCUMENTATION**: http://xvik.github.io/dropwizard-guicey/ - -Additional repositories: - -* [Examples](https://github.com/xvik/dropwizard-guicey-examples) -* [Extensions and integrations](https://github.com/xvik/dropwizard-guicey-ext) - -Support: [discussions](https://github.com/xvik/dropwizard-guicey/discussions) | [gitter chat](https://gitter.im/xvik/dropwizard-guicey) - -### About - -[Dropwizard](http://dropwizard.io/) 2.1.1 [guice](https://github.com/google/guice) 5.1.0 integration. - -Features: - -* Auto configuration from classpath scan and guice bindings. -* Yaml config values bindings by path or unique sub objects. -* Advanced Web support -* Dropwizard style console reporting: detected (and installed) extensions are printed to console to remove uncertainty -* Test support: custom junit and spock extensions -* Advanced test abilities to disable or override application logic -* Developer friendly: - - core integrations may be replaced (to better fit needs) - - rich api for developing custom integrations, and hooking into lifecycle) - - out of the box support for plug-n-play plugins (auto discoverable) - - diagnostic tools (reports), support for custom diagnostic tools - -### Sponsors - -    [![Channel](src/doc/docs/img/sponsors/zoyi-ch.png)](https://channel.io "Channel") - - -If guicey makes your life easier, you can [support its development](https://www.patreon.com/guicey). - -#### Thanks to - -* [Sébastien Boulet](https://github.com/gontard) ([intactile design](http://intactile.com)) for very useful feedback -* [Nicholas Pace](https://github.com/segfly) for governator integration - -### Setup - -[![Maven Central](https://img.shields.io/maven-central/v/ru.vyarus/dropwizard-guicey.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/ru.vyarus/dropwizard-guicey) - -May be used through [extensions project BOM](https://github.com/xvik/dropwizard-guicey-ext) or directly. - -Maven: - -```xml - - ru.vyarus - dropwizard-guicey - 5.6.1 - -``` - -Gradle: - -```groovy -implementation 'ru.vyarus:dropwizard-guicey:5.6.1' -``` - -Dropwizard | Guicey -----------|--------- -2.1| [5.6.1](http://xvik.github.io/dropwizard-guicey/5.6.1) -2.0| [5.5.0](http://xvik.github.io/dropwizard-guicey/5.5.0) -1.3| [4.2.3](http://xvik.github.io/dropwizard-guicey/4.2.3) -1.1, 1.2 | [4.1.0](http://xvik.github.io/dropwizard-guicey/4.1.0) -1.0 | [4.0.1](http://xvik.github.io/dropwizard-guicey/4.0.1) -0.9 | [3.3.0](https://github.com/xvik/dropwizard-guicey/tree/dw-0.9) -0.8 | [3.1.0](https://github.com/xvik/dropwizard-guicey/tree/dw-0.8) -0.7 | [1.1.0](https://github.com/xvik/dropwizard-guicey/tree/dw-0.7) - -WARNING: -Since dropwizard 2.1.0 [jackson blackbird](https://github.com/FasterXML/jackson-modules-base/tree/jackson-modules-base-2.13.3/blackbird#readme) -[used by default](https://www.dropwizard.io/en/release-2.1.x/manual/upgrade-notes/upgrade-notes-2_1_x.html#jackson-blackbird-as-default) instead of [afterburner](https://github.com/FasterXML/jackson-modules-base/tree/jackson-modules-base-2.13.3/afterburner#readme). -If you use **java 8** then apply afterburner dependency in order to switch into it: -``` -implementation 'com.fasterxml.jackson.module:jackson-module-afterburner:2.13.3' -``` -(omit version if guicey or dropwizard BOM used). -Without it you'll always see a nasty warning on startup (afterburner is better for java 8, but for java 9+ blackbird should be used) - - -#### BOM - -Guicey pom may be also used as maven BOM. - -NOTE: If you use guicey extensions then use [extensions BOM](https://github.com/xvik/dropwizard-guicey-ext) -instead (it already includes guicey BOM). - -BOM usage is highly recommended as it allows you to correctly update dropwizard dependencies. - -Gradle: - -```groovy -dependencies { - implementation platform('ru.vyarus:dropwizard-guicey:5.6.1') - // uncomment to override dropwizard and its dependencies versions - //implementation platform('io.dropwizard:dropwizard-dependencies:2.1.1') - - // no need to specify versions - implementation 'ru.vyarus:dropwizard-guicey' - - implementation 'io.dropwizard:dropwizard-auth' - implementation 'com.google.inject:guice-assistedinject' - - testImplementation 'ru.vyarus:spock-junit5' - testImplementation 'org.spockframework:spock-core:2.1-groovy-3.0' - testImplementation 'io.dropwizard:dropwizard-test' -} -``` - -Maven: - -```xml - - - - ru.vyarus - dropwizard-guicey - 5.6.1 - pom - import - - - - - - - - ru.vyarus - dropwizard-guicey - - -``` - -BOM includes: - -BOM | Artifact ---------------|------------------------- -Guicey itself | `ru.vyarus:dropwizard-guicey` -Dropwizard BOM | `io.dropwizard:dropwizard-bom` -Guice BOM | `com.google.inject:guice-bom` -HK2 bridge | `org.glassfish.hk2:guice-bridge` -Spock-junit5 | `ru.vyarus:spock-junit5` - - -### Snapshots - -
- Snapshots may be used through JitPack - -Add [JitPack](https://jitpack.io/#ru.vyarus/dropwizard-guicey) repository: - -```groovy -repositories { maven { url 'https://jitpack.io' } } -``` - -For spring dependencies plugin (when guicey pom used as BOM): - -```groovy -dependencyManagement { - resolutionStrategy { - cacheChangingModulesFor 0, 'seconds' - } - imports { - mavenBom "ru.vyarus:dropwizard-guicey:master-SNAPSHOT" - } -} -``` - -For direct guicey dependency: - -```groovy -configurations.all { - resolutionStrategy.cacheChangingModulesFor 0, 'seconds' -} - -dependencies { - implementation 'ru.vyarus:dropwizard-guicey:master-SNAPSHOT' -} -``` - -Note that in both cases `resolutionStrategy` setting required for correct updating snapshot with recent commits -(without it you will not always have up-to-date snapshot) - -OR you can depend on exact commit: - -* Go to [JitPack project page](https://jitpack.io/#ru.vyarus/dropwizard-guicey) -* Select `Commits` section and click `Get it` on commit you want to use and - use commit hash as version: `ru.vyarus:dropwizard-guicey:56537f7d23` - - -Maven: - -```xml - - - jitpack.io - https://jitpack.io - - - - - - - ru.vyarus - dropwizard-guicey - master-SNAPSHOT - pom - import - - - - - - - ru.vyarus - dropwizard-guicey - - -``` - -Or simply change version if used as direct dependency (repository must be also added): - -```xml - - ru.vyarus - dropwizard-guicey - master-SNAPSHOT - -``` - -
- -### Usage - -Read [documentation](http://xvik.github.io/dropwizard-guicey/) - -### Might also like - -* [yaml-updater](https://github.com/xvik/yaml-updater) - yaml configuration update tool, preserving comments and whitespaces (has dropwizard module) -* [generics-resolver](https://github.com/xvik/generics-resolver) - runtime generics resolution -* [guice-validator](https://github.com/xvik/guice-validator) - hibernate validator integration for guice -(objects validation, method arguments and return type runtime validation) -* [guice-ext-annotations](https://github.com/xvik/guice-ext-annotations) - @Log, @PostConstruct, @PreDestroy and -utilities for adding new annotations support -* [guice-persist-orient](https://github.com/xvik/guice-persist-orient) - guice integration for orientdb -* [dropwizard-orient-server](https://github.com/xvik/dropwizard-orient-server) - embedded orientdb server for dropwizard - ---- -[![java lib generator](http://img.shields.io/badge/Powered%20by-%20Java%20lib%20generator-green.svg?style=flat-square)](https://github.com/xvik/generator-lib-java)