Added notes for flyway/flyway#1807

flyway · Sep 25, 2018 · a157b97 · a157b97
1 parent 9a0c931
commit a157b97
Show file tree

Hide file tree

Showing 20 changed files with 39 additions and 160 deletions.
diff --git a/_includes/cfg/locations-commandline.html b/_includes/cfg/locations-commandline.html
@@ -0,0 +1,6 @@
+{% include cfg/_cfg.html name="locations" required=false default='<nobr>filesystem:<i>&lt;install-dir&gt;</i>/sql</nobr>'
+description="Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
+Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
+classpath and may contain both SQL and Java-based migrations.<br/>
+Locations starting with <code>filesystem:</code> point to a directory on the filesystem, may only
+contain SQL migrations and are only scanned recursively down non-hidden directories." %}
diff --git a/_includes/cfg/locations-maven-gradle.html b/_includes/cfg/locations-maven-gradle.html
@@ -0,0 +1,5 @@
+{% include cfg/_cfg.html name="locations" required=false default='filesystem:src/main/resources/db/migration' description="Locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
+Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
+classpath and may contain both SQL and Java-based migrations.<br/>
+Locations starting with <code>filesystem:</code> point to a directory on the filesystem, may only
+contain SQL migrations and are only scanned recursively down non-hidden directories." %}
diff --git a/documentation/commandline/info.md b/documentation/commandline/info.md
@@ -71,15 +71,7 @@ Prints the details and status information about all the migrations.
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr id="locations">
-        <td>locations</td>
-        <td>NO</td>
-        <td><nobr>filesystem:<i>&lt;install-dir&gt;</i>/sql</nobr></td>
-        <td>Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-commandline.html %}
     <tr id="jarDirs">
         <td>jarDirs</td>
         <td>NO</td>

diff --git a/documentation/commandline/migrate.md b/documentation/commandline/migrate.md
@@ -73,15 +73,7 @@ Migrates the schema to the latest version. Flyway will create the schema history
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr id="locations">
-        <td>locations</td>
-        <td>NO</td>
-        <td><nobr>filesystem:<i>&lt;install-dir&gt;</i>/sql</nobr></td>
-        <td>Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-commandline.html %}
     <tr id="jarDirs">
         <td>jarDirs</td>
         <td>NO</td>

diff --git a/documentation/commandline/repair.md b/documentation/commandline/repair.md
@@ -74,15 +74,7 @@ Repairs the Flyway schema history table. This will perform the following actions
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr id="locations">
-        <td>locations</td>
-        <td>NO</td>
-        <td><nobr>filesystem:<i>&lt;install-dir&gt;</i>/sql</nobr></td>
-        <td>Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-commandline.html %}
     <tr id="jarDirs">
         <td>jarDirs</td>
         <td>NO</td>

diff --git a/documentation/commandline/undo.md b/documentation/commandline/undo.md
@@ -73,15 +73,7 @@ subtitle: 'Command-line: undo'
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr id="locations">
-        <td>locations</td>
-        <td>NO</td>
-        <td><nobr>filesystem:<i>&lt;install-dir&gt;</i>/sql</nobr></td>
-        <td>Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-commandline.html %}
     <tr id="jarDirs">
         <td>jarDirs</td>
         <td>NO</td>

diff --git a/documentation/commandline/validate.md b/documentation/commandline/validate.md
@@ -77,15 +77,7 @@ Validation fails if
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr id="locations">
-        <td>locations</td>
-        <td>NO</td>
-        <td><nobr>filesystem:<i>&lt;install-dir&gt;</i>/sql</nobr></td>
-        <td>Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-commandline.html %}
     <tr id="jarDirs">
         <td>jarDirs</td>
         <td>NO</td>

diff --git a/documentation/configfiles.md b/documentation/configfiles.md
@@ -88,8 +88,9 @@ flyway.url=
 # Comma-separated list of locations to scan recursively for migrations. (default: filesystem:<<INSTALL-DIR>>/sql)
 # The location type is determined by its prefix.
 # Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain
-# both sql and java-based migrations.
-# Locations starting with filesystem: point to a directory on the filesystem and may only contain sql migrations.
+# both SQL and Java-based migrations.
+# Locations starting with filesystem: point to a directory on the filesystem, may only
+# contain SQL migrations and are only scanned recursively down non-hidden directories.
 # flyway.locations=
 
 # Comma-separated list of fully qualified class names of custom MigrationResolver to use for resolving migrations.

diff --git a/documentation/envvars.md b/documentation/envvars.md
@@ -71,8 +71,10 @@ The following environment variables are supported:
     <tr id="FLYWAY_LOCATIONS">
         <td>FLYWAY_LOCATIONS</td>
         <td>Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only contain sql migrations.
+            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
+            classpath and may contain both SQL and Java-based migrations.<br/>
+            Locations starting with <code>filesystem:</code> point to a directory on the filesystem, may only
+            contain SQL migrations and are only scanned recursively down non-hidden directories.
         </td>
     </tr>
     <tr id="FLYWAY_JAR_DIRS">

diff --git a/documentation/gradle/info.md b/documentation/gradle/info.md
@@ -71,17 +71,7 @@ Prints the details and status information about all the migrations.
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr>
-        <td>locations</td>
-        <td>NO</td>
-        <td>filesystem:src/main/resources/db/migration</td>
-        <td>Locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
-            classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only
-            contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-maven-gradle.html %}
     <tr>
         <td>sqlMigrationPrefix</td>
         <td>NO</td>

diff --git a/documentation/gradle/migrate.md b/documentation/gradle/migrate.md
@@ -71,17 +71,7 @@ Migrates the schema to the latest version. Flyway will create the schema history
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr>
-        <td>locations</td>
-        <td>NO</td>
-        <td>filesystem:src/main/resources/db/migration</td>
-        <td>Locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
-            classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only
-            contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-maven-gradle.html %}
     <tr>
         <td>sqlMigrationPrefix</td>
         <td>NO</td>

diff --git a/documentation/gradle/repair.md b/documentation/gradle/repair.md
@@ -71,17 +71,7 @@ Repairs the Flyway schema history table. This will perform the following actions
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr>
-        <td>locations</td>
-        <td>NO</td>
-        <td>filesystem:src/main/resources/db/migration</td>
-        <td>Locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
-            classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only
-            contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-maven-gradle.html %}
     <tr>
         <td>sqlMigrationPrefix</td>
         <td>NO</td>

diff --git a/documentation/gradle/undo.md b/documentation/gradle/undo.md
@@ -71,17 +71,7 @@ subtitle: 'gradle flywayUndo'
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr>
-        <td>locations</td>
-        <td>NO</td>
-        <td>filesystem:src/main/resources/db/migration</td>
-        <td>Locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
-            classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only
-            contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-maven-gradle.html %}
     <tr>
         <td>sqlMigrationPrefix</td>
         <td>NO</td>

diff --git a/documentation/gradle/validate.md b/documentation/gradle/validate.md
@@ -77,17 +77,7 @@ Validation fails if
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr>
-        <td>locations</td>
-        <td>NO</td>
-        <td>filesystem:src/main/resources/db/migration</td>
-        <td>Locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
-            classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only
-            contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-maven-gradle.html %}
     <tr>
         <td>sqlMigrationPrefix</td>
         <td>NO</td>

diff --git a/documentation/maven/info.md b/documentation/maven/info.md
@@ -80,17 +80,7 @@ Prints the details and status information about all the migrations.
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr>
-        <td>locations</td>
-        <td>NO</td>
-        <td>filesystem:src/main/resources/db/migration</td>
-        <td>Locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
-            classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only
-            contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-maven-gradle.html %}
     <tr>
         <td>sqlMigrationPrefix</td>
         <td>NO</td>

diff --git a/documentation/maven/migrate.md b/documentation/maven/migrate.md
@@ -86,17 +86,7 @@ Migrates the schema to the latest version. Flyway will create the schema history
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr id="locations">
-        <td>locations</td>
-        <td>NO</td>
-        <td>filesystem:src/main/resources/db/migration</td>
-        <td>Locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
-            classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only
-            contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-maven-gradle.html %}
     <tr>
         <td>sqlMigrationPrefix</td>
         <td>NO</td>

diff --git a/documentation/maven/repair.md b/documentation/maven/repair.md
@@ -80,17 +80,7 @@ Repairs the Flyway schema history table. This will perform the following actions
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr>
-        <td>locations</td>
-        <td>NO</td>
-        <td>filesystem:src/main/resources/db/migration</td>
-        <td>Locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
-            classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only
-            contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-maven-gradle.html %}
     <tr>
         <td>sqlMigrationPrefix</td>
         <td>NO</td>

diff --git a/documentation/maven/undo.md b/documentation/maven/undo.md
@@ -82,17 +82,7 @@ subtitle: 'mvn flyway:undo'
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr>
-        <td>locations</td>
-        <td>NO</td>
-        <td>filesystem:src/main/resources/db/migration</td>
-        <td>Locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
-            classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only
-            contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-maven-gradle.html %}
     <tr>
         <td>sqlMigrationPrefix</td>
         <td>NO</td>

diff --git a/documentation/maven/validate.md b/documentation/maven/validate.md
@@ -90,17 +90,7 @@ Validation fails if
             the schema history table is placed in the first schema of the list.
         </td>
     </tr>
-    <tr>
-        <td>locations</td>
-        <td>NO</td>
-        <td>filesystem:src/main/resources/db/migration</td>
-        <td>Locations to scan recursively for migrations. The location type is determined by its prefix.<br/>
-            Unprefixed locations or locations starting with <code>classpath:</code> point to a package on the
-            classpath and may contain both sql and java-based migrations.<br/>
-            Locations starting with <code>filesystem:</code> point to a directory on the filesystem and may only
-            contain sql migrations.
-        </td>
-    </tr>
+    {% include cfg/locations-maven-gradle.html %}
     <tr>
         <td>sqlMigrationPrefix</td>
         <td>NO</td>

diff --git a/documentation/releaseNotes.html b/documentation/releaseNotes.html
@@ -29,6 +29,11 @@ <h3>New features</h3>
         {% include issue.html id="2144" title="Command-line: Bundle MySQL JDBC driver" %}
     </ul>
 
+    <h3>Incompatible Changes</h3>
+    <ul>
+        {% include issue.html id="1807" title="Disable recursive filesystem scanning down hidden directories" %}
+    </ul>
+
     <h3>Changes</h3>
     <ul>
         {% include issue.html id="2147" title="Oracle 12.1 support is now Flyway Enterprise Edition-only" enterprise=true %}
@@ -53,7 +58,7 @@ <h3>Bug fixes</h3>
         {% include issue.html id="2143" title="COPY ... FROM fails if run after a single-line comment" %}
     </ul>
     <p>
-        Thanks to Daniel Scott, DanskerDave, Fabian Bergmark, Gili Tzabari, Guy Brand,
+        Thanks to Daniel Scott, DanskerDave, Elvadas NONO, Fabian Bergmark, Gili Tzabari, Guy Brand,
         hdconradi, HiddenKnowledge, JeP42, JLopeDeB, Joe Lee-Moyet, Matt Sprague, Matthew Burghoffer, Mihir Mehta,
         Reinhard Handler, Sajith1988V, Tim Hadwen and Valentin Gohard for reporting these issues.
     </p>