lasselehtinen/recipes

第三方部署程序配方

3.1.4 2016-06-08 09:56 UTC

README

此存储库包含与Deployer集成的第三方配方。

Gitter

使用这些配方

首先将此存储库作为开发依赖项安装。

对于Deployer 3.x

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

对于Deployer 2.x

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

包含你想要的配方。

// deploy.php

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

配方

贡献配方

所有代码贡献都必须通过pull request,并由核心开发者批准后才能合并。这是为了确保对所有代码的适当审查。

  • 分叉和克隆.
  • 创建一个分支。
    • 如果配方是为Deployer 3.x,则基于master创建你的分支
    • 如果配方是为Deployer 2.x,则基于2.x分支创建你的分支
  • 将你的配方添加到recipes文件夹中,它必须使用MIT许可。
  • docs文件夹中为你的配方添加Markdown文档,你可以从cachetool.md开始,因为它相当完整。
  • README.md中添加你的配方到上表,请使用字母顺序。
  • 提交、推送并给我们发送一个 pull request
  • 你可以使用你配方的文档作为pull request的描述。

为了确保代码库的一致性,你应该确保代码遵循PSR-2

配方做法和禁忌

为了更容易集成到现有项目中,并且减少配方及其/或其文档中的更改,你应该尽量遵循以下一般指南

  • 为配方使用短文件名。例如,使用ftp而不是ftp_upload_to_server_recype_by_me
  • 使用配方名称作为前缀的所有任务。如果你在myrecipe中有名为mytest的任务,则应命名为myrecipe:mytest
  • 使用键为你的配方名称的全局设置。如果你有一个设置,名称应与你的配方相同。如果你有多个设置,请使用关联数组
  • 使用以你的配方名称为前缀的环境变量。如果你在配方myrecipe中有一个名为better_path的环境变量,则调用它为myrecipe_better_path
  • 不要覆盖现有的任务(例如,在common.php中的任务)。相反,详细说明如何将你的配方中的任务集成到工作流程中
  • 如果你的配方依赖于另一个(无论是包含在Deployer中还是第三方) - 详细说明。对于用户来说,使用require_oncedeploy.php中,而不是强制依赖,更好。

许可

在MIT许可下发布:https://open-source.org.cn/licenses/mit-license.php