Recipes Do's and Don'ts about recipes

[antonmedv]

I think too, what 3rd-party recipes should has no effect on.
Imagine i has Symfony app based on recipe/symfony.php, but i want to use rsync. Now if i require this recipe - my deploy will be broken. Sad =(.

I think recipes has to be separated into two category:

1. Recipe with useful tasks (as library)
2. Recipe which provide workflow (as workflow)

cachetool.php, slack.php, and other is 1 type.
recipe/common.php and derivative is 2 type.

rsync.php recipe in #10 now is 2 type too, but must be separated into two:

• rsync as useful tasks,
• shared hosting workflow.

[johnny-bit]

sooo I went ahead and changed rsync.php into type 1. now rsync is a useful task 😃

Now... to shared hosting workflow!

[johnny-bit]

So to sum up some suggestions from #10 and #12:

• use short file names. Eg ftp instead of ftp_upload_to_server_recype_by_me
• prefix tasks with recipe name. if You have task named mytest in myrecipe it should be named myrecipe:mytest
• use global settings keyed by your recipe name. If You have one setting, name it the same as Your recipe. If You have multiple settings, use associative array
• use environment variables prefixed by Your recipe name. If You have environment varaible named better_path in recipe myrecipe, call it myrecipe_better_path

did I miss something?

[gordalina]

that looks about right :)

[antonmedv]

Good 👍