Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xvik committed May 14, 2023
1 parent 7f2e6c4 commit 4bf400d
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 30 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
### 5.9.0 (2023-05-14)
* Update to guice 6.0

### 5.8.1 (2023-04-28)
* Fix BOM for correct guava version selection in maven (#302)

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Support: [discussions](https://github.com/xvik/dropwizard-guicey/discussions) |

### About

[Dropwizard](http://dropwizard.io/) 2.1.6 [guice](https://github.com/google/guice) 5.1.0 integration.
[Dropwizard](http://dropwizard.io/) 2.1.6 [guice](https://github.com/google/guice) 6.0.0 integration.

Features:

Expand Down Expand Up @@ -46,19 +46,19 @@ Maven:
<dependency>
<groupId>ru.vyarus</groupId>
<artifactId>dropwizard-guicey</artifactId>
<version>5.8.1</version>
<version>5.9.0</version>
</dependency>
```

Gradle:

```groovy
implementation 'ru.vyarus:dropwizard-guicey:5.8.1'
implementation 'ru.vyarus:dropwizard-guicey:5.9.0'
```

Dropwizard | Guicey
----------|---------
2.1| [5.8.1](http://xvik.github.io/dropwizard-guicey/5.8.1)
2.1| [5.9.0](http://xvik.github.io/dropwizard-guicey/5.9.0)
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)
Expand Down Expand Up @@ -87,7 +87,7 @@ Gradle:

```groovy
dependencies {
implementation platform('ru.vyarus.guicey:guicey-bom:5.8.1')
implementation platform('ru.vyarus.guicey:guicey-bom:5.9.0')
// uncomment to override dropwizard and its dependencies versions
//implementation platform('io.dropwizard:dropwizard-dependencies:2.1.6')
Expand All @@ -110,7 +110,7 @@ Maven:
<dependency>
<groupId>ru.vyarus.guicey</groupId>
<artifactId>guicey-bom</artifactId>
<version>5.8.1</version>
<version>5.9.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
4 changes: 2 additions & 2 deletions dropwizard-guicey/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ javaLib {

mkdocs {
publish {
docPath = '5.8.1'
docPath = '5.9.0'
rootRedirect = false
}
extras = [
'version': '5.8.1',
'version': '5.9.0',
'dropwizard': rootProject.dropwizard,
'guice': rootProject.guice
]
Expand Down
2 changes: 1 addition & 1 deletion dropwizard-guicey/src/doc/docs/about/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Dropwizard | Guicey
----------|---------
2.1.0 | [5.7.1](http://xvik.github.io/dropwizard-guicey/5.7.1)
2.1.0 | [5.9.0](http://xvik.github.io/dropwizard-guicey/5.9.0)
2.0.0 | [5.5.0](http://xvik.github.io/dropwizard-guicey/5.5.0)
1.3.0 | [4.2.3](http://xvik.github.io/dropwizard-guicey/4.2.3)
1.2.0 | [4.1.0](http://xvik.github.io/dropwizard-guicey/4.1.0)
Expand Down
3 changes: 3 additions & 0 deletions dropwizard-guicey/src/doc/docs/about/history.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
### [5.9.0](http://xvik.github.io/dropwizard-guicey/5.9.0) (2023-05-14)
* Update to guice 6.0

### [5.8.1](http://xvik.github.io/dropwizard-guicey/5.8.1) (2023-04-28)
* Fix BOM for correct guava version selection in maven (#302)

Expand Down
26 changes: 5 additions & 21 deletions dropwizard-guicey/src/doc/docs/about/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,9 @@
# 5.8.0 Release Notes
# 5.9.0 Release Notes

* Update to dropwizard 2.1.6
* Extensions merged into core guicey repository
* Update to guice 6.0.0

This version brings the same project structure as in guicey 6.x (for dropwizard 3) which
could slightly simplify migration to dropwizard 3.
## Guice 6.0

The same structure is required to keep 2.1, 3 and 4 branches in sync
No breaking changes.


## Extensions merged into core guicey repository

Extensions were merged into core guicey repository in order to unify versioning (and simplify releases).
Maven coordinates for modules stayed the same.

Dropwizard-guicey POM does not contain dependencyManagement section anymore and so can't
be used as a BOM. Instead, use `ru.vyarus.guicey:guicey-bom` - it contains everything now.

Also, dropwizard-guicey POM was simplified: all exclusions were moved directly into dependencies section
instead relying on dependencyManagement.

`dopwizard-flyway` module was removed from BOM (in order to minimize external dependencies).

Examples repository was also merged [inside main repo](https://github.com/xvik/dropwizard-guicey/tree/dw-2.1/examples)
See [guice 6.0 release notes](https://github.com/google/guice/wiki/Guice600).

0 comments on commit 4bf400d

Please sign in to comment.