From 2748ffd69e2b691ee9fafd4f8ef5783cefde483a Mon Sep 17 00:00:00 2001
From: Midhun Monachan <midhunmonachan@gmail.com>
Date: Wed, 22 May 2024 23:56:31 -0400
Subject: [PATCH 1/2] Improvise configuration output message for
 provision:configure

---
 recipe/provision.php | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/recipe/provision.php b/recipe/provision.php
index cbb4b50a2..3a7464875 100644
--- a/recipe/provision.php
+++ b/recipe/provision.php
@@ -73,12 +73,17 @@
         'db_name',
         'db_password',
     ];
-    $code = "\n\n    host(<info>'{{alias}}'</info>)";
-    foreach ($params as $name) {
-        $code .= "\n        ->set(<info>'$name'</info>, <info>'…'</info>)";
+    $code = "\n\n<comment>* To streamline script execution, include the following configuration in your <info>deploy.php</info>.</comment>";
+    $code .= "\n<fg=magenta> - Do not include sensitive information if the file is shared. Replace <info>…</info> with actual data</>";
+    $code .= "\n<fg=magenta> - If a database configuration is not required, 'db_user', 'db_name', and 'db_password' can be omitted.</>";
+    $code .= "\n\n<comment>====== Configuration Start ======</comment>";
+    $code .= "\nhost(<info>'{{alias}}'</info>)";
+    foreach (array_merge($params, $dbparams) as $name) {
+        $code .= "\n    ->set(<info>'$name'</info>, <info>'…'</info>)";
     }
-    $code .= ";\n\n";
-    writeln($code);    
+    $code .= ";\n";
+    $code .= "<comment>====== Configuration End ======</comment>\n\n";
+    writeln($code);
     foreach ($params as $name) {
         get($name);
     }

From fb783394796e7bb190a9d0043719ca8382a7de9b Mon Sep 17 00:00:00 2001
From: Midhun Monachan <midhunmonachan@gmail.com>
Date: Thu, 23 May 2024 00:05:40 -0400
Subject: [PATCH 2/2] Regenerate docs using php bin/docgen

---
 docs/recipe/provision.md | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/docs/recipe/provision.md b/docs/recipe/provision.md
index ceabe37fb..3d18fa644 100644
--- a/docs/recipe/provision.md
+++ b/docs/recipe/provision.md
@@ -29,7 +29,7 @@ return run("lsb_release -s -c");
 
 
 ### sudo_password
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L228)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L233)
 
 
 
@@ -39,7 +39,7 @@ return askHiddenResponse(' Password for sudo: ');
 
 
 ### ssh_copy_id
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L234)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L239)
 
 Specify which key to copy to server.
 Set to `false` to disable copy of key.
@@ -95,7 +95,7 @@ Collects required params.
 
 
 ### provision:update
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L94)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L99)
 
 Adds repositories and update.
 
@@ -103,7 +103,7 @@ Adds repositories and update.
 
 
 ### provision:upgrade
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L116)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L121)
 
 Upgrades all packages.
 
@@ -111,7 +111,7 @@ Upgrades all packages.
 
 
 ### provision:install
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L123)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L128)
 
 Installs packages.
 
@@ -119,7 +119,7 @@ Installs packages.
 
 
 ### provision:server
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L157)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L162)
 
 Configures a server.
 
@@ -127,7 +127,7 @@ Configures a server.
 
 
 ### provision:ssh
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L218)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L223)
 
 Configures the ssh.
 
@@ -135,7 +135,7 @@ Configures the ssh.
 
 
 ### provision:deployer
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L237)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L242)
 
 Setups a deployer user.
 
@@ -143,7 +143,7 @@ Setups a deployer user.
 
 
 ### provision:firewall
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L284)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L289)
 
 Setups a firewall.
 
@@ -151,7 +151,7 @@ Setups a firewall.
 
 
 ### provision:verify
-[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L292)
+[Source](https://github.com/deployphp/deployer/blob/master/recipe/provision.php#L297)
 
 Verifies what provision was successful.