Add flyway defaults properties, autoloading default config file #19
Conversation
|
Hi @sivaprasadreddy , hope you are doing well. |
|
|
||
| ## Migration tools: | ||
|
|
||
| ### Flyway |
There was a problem hiding this comment.
Adding basic information about Flyway with a link to official flyway documentation would be good.
README.md
Outdated
| - Plugin migration and code generation might be skipped using `skip` property <br/> | ||
| - If you need to reuse existing database connection - take a look at [Jooq section](#Jooq) | ||
|
|
||
| ## Databases: |
There was a problem hiding this comment.
Should it be "Database Configuration:"?
README.md
Outdated
| The `testcontainers-jooq-codegen-maven-plugin` simplifies the jOOQ code generation | ||
| by using [Testcontainers](https://www.testcontainers.org/) and applying database migrations. | ||
| The `testcontainers-jooq-codegen-maven-plugin` simplifies the jOOQ code generation | ||
| by using [Testcontainers](https://www.testcontainers.org/) and applying database migrations. <br/> |
There was a problem hiding this comment.
I think we don't need to add HTML <br/> tags. Adding 2 blank lines is sufficient.
| </flyway> | ||
| ``` | ||
|
|
||
| ### Liquibase |
There was a problem hiding this comment.
Adding basic Liquibase info with a link to official Liquibase docs will be good.
README.md
Outdated
|
|
||
| #### Properties | ||
|
|
||
| `generator` - property to configure JOOQ generation plugin itself, original |
There was a problem hiding this comment.
This can be rephrased to generator - property to configure JOOQ code generation settings. See https://www.jooq.org/doc/latest/manual/code-generation/codegen-configuration for all the supporting configuration properties.
README.md
Outdated
| existing database will be used, no container won't be spin up <br/> | ||
| `baseDir` - directory relative to which generated sources will be generated , `{project.basedir}` - default | ||
|
|
||
| #### In order to configure JOOQ add `jooq` block to your plugin `configuration` |
There was a problem hiding this comment.
Heading can be "jooq block configuration"
README.md
Outdated
|
|
||
| Reference to Liquibase properties - https://docs.liquibase.com/concepts/connections/creating-config-properties.html | ||
|
|
||
| #### In order to use Liquibase add `liquibase` block to your plugin `configuration` |
There was a problem hiding this comment.
Heading can be "liquibase block configuration"
README.md
Outdated
| </jooq> | ||
| ``` | ||
|
|
||
| #### Before run - Make sure your plugin has dependency on a chosen jdbc database driver implementation |
There was a problem hiding this comment.
Heading can be "Plugin dependencies configuration"
| </dependency> | ||
| ``` | ||
|
|
||
| ## Examples |
There was a problem hiding this comment.
Before Examples section, it would be good to have a complete plugin configuration example.
| @@ -88,6 +89,11 @@ | |||
| </exclusion> | |||
| </exclusions> | |||
| </dependency> | |||
| <dependency> | |||
There was a problem hiding this comment.
Personally, I didn't face any problems using Lombok, but a lot of people don't like to use Lombok because of some unforeseen issues, especially combined with other tools. So, I would prefer not to use Lombok as we might not even need Lombok features so much.
There was a problem hiding this comment.
Totally agree, we might, but this way I reduced code size thrice, there are pretty much duplications without Lombok.
if you are 100 percent against it then - I will remove it
|
Hi @sivaprasadreddy , pls review once again, I've fixed all of the comments except Lombok. |
In scope of this pull request i've done
flyway.confaccording to original Flyway implementationskipproperty to root configurationlocationsfor Flyway as in original implementationreadmeand links to examples (will extendreadmemore later)Partially improves: #18
Resolves: #15