Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antonmedv merged 2 commits into from
May 23, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2748ffd
Improvise configuration output message for provision:configure
midhunmonachan May 23, 2024
fb78339
Regenerate docs using php bin/docgen
midhunmonachan May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/recipe/provision.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)



Expand All @@ -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.
Expand Down Expand Up @@ -95,63 +95,63 @@ 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.




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




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




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




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




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




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




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

Expand Down
15 changes: 10 additions & 5 deletions recipe/provision.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down