mirror_php/deployer
1
0
Fork 0
mirror of https://github.com/deployphp/deployer.git synced 2025-02-19 23:04:40 +01:00
Code Issues Projects Releases Wiki Activity

Improve the configuration options console output in provision:configure (#3840)

Browse Source 
* Improvise configuration output message for provision:configure

* Regenerate docs using php bin/docgen
This commit is contained in:
Midhun Monachan 2024-05-23 05:30:55 -04:00 committed by GitHub
parent 03ffe144c0
commit 42ccdc8665
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 20 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/recipe/provision.md
View File

@ -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.

15
recipe/provision.php
View File

@ -73,12 +73,17 @@ task('provision:configure', function () {
'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);
}