2017 © Pedro Peláez
 

library recipes

3rd party deployer recipes

image

lasselehtinen/recipes

3rd party deployer recipes

  • Wednesday, June 8, 2016
  • by lasleh
  • Repository
  • 1 Watchers
  • 0 Stars
  • 27 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 111 Forks
  • 0 Open issues
  • 25 Versions
  • 0 % Grown

The README.md

Deployer Recipes

This repository contains third party recipes to integrate with deployer., (*1)

Gitter, (*2)

Using these recipes

First install this repository as a dev dependency., (*3)

For Deployer 3.x, (*4)

$ php composer.phar require --dev "deployphp/recipes ~3.0"

For Deployer 2.x, (*5)

$ php composer.phar require --dev "deployphp/recipes ~2.0"

Include the recipes to your will., (*6)

// deploy.php

require 'vendor/deployphp/recipes/recipes/cachetool.php';

Recipes

Recipe Docs Usage
cachetool read require 'vendor/deployphp/recipes/recipes/cachetool.php';
local read require 'vendor/deployphp/recipes/recipes/local.php';
newrelic read require 'vendor/deployphp/recipes/recipes/newrelic.php';
rabbit read require 'vendor/deployphp/recipes/recipes/rabbit.php';
rsync read require 'vendor/deployphp/recipes/recipes/rsync.php';
slack read require 'vendor/deployphp/recipes/recipes/slack.php';
configure read require 'vendor/deployphp/recipes/recipes/configure.php';
hipchat read require 'vendor/deployphp/recipes/recipes/hipchat.php';

Contributing a recipe

All code contributions must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code., (*7)

  • Fork and clone.
  • Create a branch.
    • If the recipe is for Deployer 3.x then create your branch based on master
    • If the recipe is for Deployer 2.x then create your branch based on the 2.x branch
  • Add your recipe to the recipes folder, it must be licensed as MIT.
  • Add documentation in Markdown for your recipe to the docs folder, you can base your documentation from cachetool.md as it is fairly complete.
  • Add your recipe to the table above in README.md, please use alphabetical order.
  • Commit, push and send us a pull request.
  • You can use the documentation of your recipe as a description to your pull request.

To ensure a consistent code base, you should make sure the code follows the PSR-2., (*8)

Recipe Do's and Don'ts

For easier integration in existing project, and fewer changes in your recipe and/or docs for it, you should try and follow this general guidelines:, (*9)

  • Use short file names for recipes. Eg ftp instead of ftp_upload_to_server_recype_by_me
  • Prefix all tasks in recipe 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
  • Do not override existing tasks (for example - those in common.php). Instead document throughtly how tasks from your recipe can be integrated into workflow
  • If your recipe depends on another (be it included in deployer or 3rd party) - document it throughtly. It's better for user to use require_once in deploy.php, rather than force dependecies.

License

Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php, (*10)

The Versions

08/06 2016

dev-master

9999999-dev https://github.com/lasselehtinen/recipes

3rd party deployer recipes

  Sources   Download

MIT

by Lasse Lehtinen

deployment slack deploy newrelic deployer recipes cachetool

08/06 2016

3.1.4

3.1.4.0 https://github.com/lasselehtinen/recipes

3rd party deployer recipes

  Sources   Download

MIT

by Lasse Lehtinen

deployment slack deploy newrelic deployer recipes cachetool

08/06 2016

3.1.3

3.1.3.0 https://github.com/lasselehtinen/recipes

3rd party deployer recipes

  Sources   Download

MIT

by Lasse Lehtinen

deployment slack deploy newrelic deployer recipes cachetool

08/06 2016

3.1.1

3.1.1.0 https://github.com/lasselehtinen/recipes

3rd party deployer recipes

  Sources   Download

MIT

by Lasse Lehtinen

deployment slack deploy newrelic deployer recipes cachetool

08/06 2016

3.1.2

3.1.2.0 https://github.com/lasselehtinen/recipes

3rd party deployer recipes

  Sources   Download

MIT

by Lasse Lehtinen

deployment slack deploy newrelic deployer recipes cachetool

12/04 2016

3.1.0

3.1.0.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

22/10 2015

3.0.11

3.0.11.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

22/08 2015

3.0.10

3.0.10.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

18/08 2015

3.0.9.1

3.0.9.1 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

18/08 2015

3.0.9

3.0.9.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

04/08 2015

3.0.8

3.0.8.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

30/07 2015

3.0.7

3.0.7.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

22/07 2015

3.0.6

3.0.6.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

06/07 2015

3.0.5

3.0.5.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

29/06 2015

3.0.4

3.0.4.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

19/06 2015

3.0.3

3.0.3.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

18/06 2015

dev-fix/readme-links

dev-fix/readme-links https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

18/06 2015

3.0.2

3.0.2.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

16/06 2015

3.0.1

3.0.1.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

20/03 2015

3.0.0

3.0.0.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

06/02 2015

2.x-dev

2.9999999.9999999.9999999-dev https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

06/02 2015

1.0.2

1.0.2.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

06/02 2015

2.0.0

2.0.0.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

03/02 2015

1.0.1

1.0.1.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool

30/01 2015

1.0.0

1.0.0.0 https://github.com/deployphp/recipes

3rd party deployer recipes

  Sources   Download

MIT

deployment slack deploy newrelic deployer recipes cachetool