codenamephp/build.cli

此包已被废弃,不再维护。未建议替代包。

构建命令的CLI前端,通过命令行实现创建新项目等常见项目任务。

1.0.2 2016-11-12 16:49 UTC

This package is auto-updated.

Last update: 2020-08-18 20:00:33 UTC


README

安装

###全局

  composer global require codenamephp/build.cli

这将全局安装构建工具。如果您已将全局composer bin文件夹设置为路径的一部分,您可以从shell中的任何位置执行build命令。

非全局

  composer create-project codenamephp/build.cli {local folder} dev-master --keep-vcs [--no-dev]

这将检出最新版本的构建命令行界面到指定的本地文件夹,并保留git仓库以便稍后更新。

更新

全局

再次执行

  composer global require codenamephp/build.cli

并确保选择了最新版本。您当然可以手动更新全局composer.json中的版本并执行composer global update

非全局

由于是从git克隆的仓库,只需在本地文件夹中执行git pull && composer update

配置

应用程序通过DI容器进行配置。di/definitions文件夹包含所有*.local.php文件。这些文件通过.git commit排除,因此可以包含所有本地配置,如API令牌、密码等。

可以使用DI配置更改所有类和值。

同一文件夹中还有一个properties.local.template.php文件。复制并重命名为properties.local.php,填写属性以开始使用。模板包含以下属性

github.apiToken (字符串)

用于通过github API进行认证的认证令牌:https://help.github.com/articles/creating-an-access-token-for-command-line-use/ 确保令牌具有创建和编辑仓库的权限

github.organization (字符串)

将在其中创建仓库的github组织

packagist.apiToken (字符串)

用于在github仓库中创建webhook时使用的packagist authToken

packagist.username (字符串)

用于在github仓库中创建webhook时使用的packagist用户名

baseFolder (字符串)

项目的创建基础路径。该路径必须是绝对路径。如果您设置基础路径为"/home/user/work"并给出项目名称为"project",最终的项目路径将是/home/user/work/project

使用方法

构建工具以 Symfony CLI 应用程序的形式实现,构建脚本是 php 可执行文件。

全局

如果您已全局安装了构建工具并且已将路径设置为包含全局 composer bin 文件夹,您只需

build <command>

在系统中的任何位置即可。

非全局

在您的本地工作副本中执行二进制文件

{local folder}/bin/build <command>

命令、选项和参数

某些命令可能还接受额外的选项和参数,具体取决于它们的任务。运行

build list

以获取命令的完整列表,并

build help <command>

以获取命令的附加描述和选项列表。

可用命令

CreateProject

创建一个新项目,包括存储库、从原型创建的基础代码等。以下步骤将被执行

  • 创建 github 仓库
  • 从 composer 原型创建项目
  • 创建 master 分支,将创建的 github 仓库设置为 origin,添加本地文件,提交并推送
  • 在 github 仓库中创建 packagist webhook