mentosmenno2/sftp-deploy

将项目部署到 SFTP 服务器上的软件包

维护者

详细信息

github.com/mentosmenno2/sftp-deploy

源代码

问题

安装: 121

依赖项: 0

建议者: 0

安全: 0

星级: 1

关注者: 2

分支: 1

开放性问题: 2

v1.1.1 2020-05-11 21:07 UTC

Requires

Requires (Dev)

MIT a62b6986e719bb5f48a810a3e003a3e7199f130d

  • mentosmenno2 <mentosmenno2.woop@hotmail.com>

This package is auto-updated.

Last update: 2024-09-12 06:59:59 UTC

README

GitHub Actions status

Mentosmenno2 SFTP Deploy

通过 (S)FTP 简单命令构建和部署 PHP 应用程序！

要求

  • PHP 7.1+

安装

使用 composer 将此依赖项安装为开发依赖项。

composer require mentosmenno2/sftp-deploy --dev

通过在 composer.json 文件中添加以下内容将命令添加到 Composer 脚本。

"scripts": {
	"sftp-deploy" : [
		"sftp-deploy"
	],
	"deploy": [
		"@sftp-deploy deploy"
	]
}

配置

使用 init 命令生成配置文件。请参阅下方的命令部分。

打开生成的 sftp-deploy.config.json 文件，并按照以下规范编辑属性。

配置文件属性

您还可以使用自定义配置文件。为此，您可以使用 config 操作符指定您的自定义配置文件。如果您这样做，您还应该更改当前的部署命令（参见安装部分），或者创建一个新的命令。

"scripts": {
	"deploy": [
		"@sftp-deploy deploy -- --config=\"custom-config-filename.json\""
	]
}

命令

所有命令都可以以下方式运行

composer run sftp-deploy COMMAND_NAME

初始化

生成配置文件。此文件将命名为 sftp-deploy.config.json。

composer run sftp-deploy init

构建

构建应用程序。

composer run sftp-deploy build [checkout]

参数

部署

构建并将应用程序部署到 (S)FTP 服务器。

执行以下操作

  • 首先使用 build 命令构建您的应用程序。
  • 然后将构建部署到 (S)FTP 服务器。
  • 最后使用 cleanup 命令清理旧构建。
composer run sftp-deploy deploy [checkout]

参数

清理

清理旧构建。

注意

  • 此功能仅在配置中启用 builds_use_subdirectory 时才有效。
  • 保留最多 builds_keep_revisions 个完整版本。请参阅配置。
composer run sftp-deploy deploy

贡献

您可以为此项目做出贡献。我希望这个项目变得更好，就像您一样。

如果您想做出贡献，请创建一个分支，并提交一个 pull request。

请注意，您的 pull request 必须遵守以下规则

  • 它必须包含为何需要或有用性的描述。
  • 它必须包含修复所做更改的描述。
  • 如果某些代码对其他开发者来说可能不够清晰，请添加注释。
  • 代码必须通过自动 GitHub 动作检查。您可以通过运行 composer run test 在本地进行测试。

本地安装

git clone git@github.com:mentosmenno2/sftp-deploy.git
composer install
composer dump-autoload

代码检查

代码必须通过代码检查才能用于此项目。

composer run test

您还可以让代码检查器尝试自行修复问题。

注意： 这仅修复常见问题。您可能仍然需要自行修复一些问题。

composer run fix