From 78c65edfcfdce450dad478c0d9ef91e524c31f7a Mon Sep 17 00:00:00 2001
From: Nathan Fischer <nfischer921@gmail.com>
Date: Tue, 9 Apr 2019 16:56:59 -0700
Subject: Short doc

---
 docs/pages/9 - Contrib Modules.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

(limited to 'docs')

diff --git a/docs/pages/9 - Contrib Modules.md b/docs/pages/9 - Contrib Modules.md
index 73875961..7bf29dc2 100644
--- a/docs/pages/9 - Contrib Modules.md	
+++ b/docs/pages/9 - Contrib Modules.md	
@@ -37,6 +37,36 @@ object project extends BuildInfo {
 
 * `def buildInfoPackageName: Option[String]`, default: `None`
   The package name of the object.
+  
+  
+### Flyway
+
+Enables you to configure and run [Flyway](https://flywaydb.org/) commands from your mill build file.
+The flyway module currently supports the most common flyway use cases with file based migrations.
+
+Configure flyway by overriding settings in your module. For example
+
+```scala
+object foo extends JavaModule with FlywayModule {
+  def scalaVersion = "2.12.8"
+  
+  //region flyway
+  def flywayUrl = "jdbc:postgresql:myDb" // required
+  def flywayDriverDeps = Agg(ivy"org.postgresql:postgresql:42.2.5") // required
+  def flywayUser = "postgres" // optional
+  // def flywayPassword = "" // optional
+  //endregion
+}
+```
+
+Flyway will look for migration files in `db/migration` in all resources folders by default.
+
+You can then run common flyway commands like
+```
+mill foo.flywayClean
+mill foo.flywayInfo
+mill foo.flywayMigrate
+```
 
 ### Play Framework
 
-- 
cgit v1.2.3