README

Phabalicious 使用存储在项目根目录中特殊文件（fabfile.yaml）中的配置来在 shell 中运行任务。这个 shell 可以由 docker 容器、ssh 连接或本地 shell 提供。这意味着，你可以在 fabfile 中存储所有你的 devops 脚本，并将其应用于一系列配置。Phabalicious 尝试抽象化主机的内部工作原理，并为用户提供一些有用的命令来运行常见任务，例如：

• 将新代码部署到远程安装
• 将远程安装重置为其默认值。
• 备份数据/恢复数据
• 将数据从一个安装复制到另一个安装
• 搭建新项目
• 在不同本地或远程安装和运行上下文中运行脚本
• 透明处理 SSH 隧道
• 触发网关
• 通过 mattermost 发送通知
• 与 kubernetes 集群交互和部署

它很好地与现有的解决方案集成，如持续集成、基于 docker 的设置或不同的托管环境，如 lagoon、platform.sh 或复杂的自定义 IT 基础设施。

文档

您可以在 docs.phab.io 找到文档。

安装

Phabalicious 需要 PHP 7.3 及以上版本，并包含 json- 和 openssl- 扩展。大多数方法依赖于已安装的 cli 命令，如果找不到它们，您将收到错误消息。

通过 homebrew 安装（mac os x）

brew tap factorial-io/homebrew-phabalicious
brew install phab

• 如果您之前已安装 phab，您可能需要从 /usr/local/bin 中删除 phab

使用已发布的 phar 安装

• 从 Github 下载最新版本
• 将 phar 复制到合适的文件夹，例如 cp phabalicious.phar /usr/local/bin/phab
• 使其可执行，例如 chmod u+x /usr/local/bin/phab

有关安装的更多信息，请参阅 安装指南

增强 phab，为 phab 贡献

我们欢迎贡献！请分支仓库，创建一个功能分支并提交一个 pull-request。

请为您的错误修复或新功能添加测试用例。我们在提交新代码时使用 GrumPHP 检查代码风格（PSR2）、运行测试等。此仓库使用 github-flow 作为分支策略。

提交消息

项目还遵循常规提交最佳实践（自 3.8 版起），您可以运行

yarn install
yarn cz # if you have installed commitizen globally you can use also git cz

以获取提交消息的辅助器。我们使用 method 名称作为 type 在提交消息中分组它们，例如 feat(k8s): 支持helm

创建一个发布版本

此存储库使用 github-flow 来管理版本。发布由 github-action 自动创建。Phab 使用 standard-version来自动准备发布。它将负责增加版本号和更新变更日志。

要准备一个新发布版本，请运行以下命令

yarn install && yarn release

要准备一个预发布版本（例如 beta 版本）

yarn install && yarn standard-version  --  -t '' --sign --prerelease

重新构建文档

文档使用 vuepress 构建，因此您需要先运行 yarn install。

在本地审查

运行 yarn docs:dev，这将允许您使用浏览器浏览文档，并具有热重载和所有其他花哨的功能

构建和发布文档

运行 yarn docs:build。这将构建文档并将其推送到gh-pages分支。随后，GitHub将发布这些更改至https://factorial-io.github.io/phabalicious/