From 52e4fa84c2476a575be47d7399d2e70600c3c828 Mon Sep 17 00:00:00 2001
From: Kevin Inman <47095624+inmanturbo@users.noreply.github.com>
Date: Sun, 23 Mar 2025 19:42:18 -0400
Subject: [PATCH 1/4] Update migrations.md
---
migrations.md | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/migrations.md b/migrations.md
index 34499bb1c2..7e9d49fc92 100644
--- a/migrations.md
+++ b/migrations.md
@@ -134,6 +134,23 @@ public function up(): void
}
```
+
+#### Skipping Migrations
+
+If your migration has dependencies or is meant to support a feature that may not be activate yet, you may not want it to run unless its requirements are met. In this case you should implement the optional `shouldRun` method, to return a boolean value based on your needs:
+
+```php
+/**
+ * Determine if this migration should run.
+ *
+ * @return bool
+ */
+public function shouldRun()
+{
+ return Feature::active(Flights::class);
+}
+```
+
## Running Migrations
From bf76b5689ef7bf86517c89f24678cdb5ed3bb59e Mon Sep 17 00:00:00 2001
From: Kevin Inman <47095624+inmanturbo@users.noreply.github.com>
Date: Mon, 24 Mar 2025 13:09:02 -0400
Subject: [PATCH 2/4] Update migrations.md
---
migrations.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/migrations.md b/migrations.md
index 7e9d49fc92..51f4621b18 100644
--- a/migrations.md
+++ b/migrations.md
@@ -137,7 +137,7 @@ public function up(): void
#### Skipping Migrations
-If your migration has dependencies or is meant to support a feature that may not be activate yet, you may not want it to run unless its requirements are met. In this case you should implement the optional `shouldRun` method, to return a boolean value based on your needs:
+If your migration has dependencies or is meant to support a feature that may not be active yet, you may not want it to run unless its requirements are met. In this case you should implement the optional `shouldRun` method, to return a boolean value based on your needs:
```php
/**
From 88f32f8135557071fb4c1e3df542c712735131dc Mon Sep 17 00:00:00 2001
From: Kevin Inman <47095624+inmanturbo@users.noreply.github.com>
Date: Mon, 24 Mar 2025 13:16:22 -0400
Subject: [PATCH 3/4] wording
---
migrations.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/migrations.md b/migrations.md
index 51f4621b18..c35d49c429 100644
--- a/migrations.md
+++ b/migrations.md
@@ -137,7 +137,7 @@ public function up(): void
#### Skipping Migrations
-If your migration has dependencies or is meant to support a feature that may not be active yet, you may not want it to run unless its requirements are met. In this case you should implement the optional `shouldRun` method, to return a boolean value based on your needs:
+If your migration has unmet dependencies or is meant to support a feature that is not yet active, you likely do not want it to run until its requirements have been met. In this case you should implement the optional `shouldRun` method, to return a boolean value based on your needs:
```php
/**
From fcfcd1e1629278b278be139ca1efc6be7cbe12ba Mon Sep 17 00:00:00 2001
From: Taylor Otwell
Date: Sat, 29 Mar 2025 12:42:06 -0500
Subject: [PATCH 4/4] formatting
---
migrations.md | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/migrations.md b/migrations.md
index c35d49c429..2d40e5cecd 100644
--- a/migrations.md
+++ b/migrations.md
@@ -137,15 +137,13 @@ public function up(): void
#### Skipping Migrations
-If your migration has unmet dependencies or is meant to support a feature that is not yet active, you likely do not want it to run until its requirements have been met. In this case you should implement the optional `shouldRun` method, to return a boolean value based on your needs:
+Sometimes a migration might be meant to support a feature that is not yet active and you do not want it to run yet. In this case you may define a `shouldRun` method on the migration. If the `shouldRun` method returns `false`, the migration will be skipped:
```php
/**
* Determine if this migration should run.
- *
- * @return bool
*/
-public function shouldRun()
+public function shouldRun(): bool
{
return Feature::active(Flights::class);
}