elegantthemes/github-archive-installer

这是一个自定义Composer安装器,当从发行版安装时,它将从GitHub发布存档.zip文件中安装依赖项。

安装: 36

依赖者: 0

建议者: 0

安全: 0

星星: 0

关注者: 1

分支: 4

类型:composer-plugin

2.1.3 2021-12-01 18:47 UTC

This package is not auto-updated.

Last update: 2024-09-19 08:04:52 UTC


README

这是一个自定义Composer安装器,当从发行版安装时,它将从GitHub发布存档.zip文件中安装依赖项。

为什么你需要它

在代码库源文件中,你可能有很多只用于开发的文件。除非明确从源安装,否则你通常不需要在最终发行版中包含只用于开发的文件。你也可能需要执行一些特定的构建步骤,例如构建一些生产就绪的JavaScript文件。此安装器允许你将生成的代码保留在外部仓库中,同时仍然能够在最终发行版中可靠地交付它。

使用像Travis CI这样的工具,你可以自动构建最终发行版,并将生成的.zip文件自动附加到GitHub上的发布。然后,使用此安装器,你可以轻松配置库,在Composer中安装作为dist的生成.zip文件。

它是如何工作的

任何直接依赖elegantthemes/github-archive-installer并且安装了有效稳定版本号的包,都将从与特定发布相关联的GitHub存档<repo-name>.zip文件中安装。

例如,如果我的Composer包名为elegantthemes/hello-world,那么我的生成的.zip文件应该命名为hello-world.zip,以便使用此安装器正确安装。

此安装器仅更改Composer中包的distUrl。它不会覆盖基于你composer.json文件中type属性的现有安装器。例如,如果你有一个类型为wordpress-plugin的包,你的包仍然会安装到WordPress的正确位置。然而,当从dist安装时,它将简单地从附加到你的GitHub发布的.zip文件中提取。

选项

以下选项可以包含在composer.json中,以自定义如何生成dist下载URL

生成的dist下载URL将类似于以下格式:https://github.com/${org-name}/${repo-name}/releases/download/${version}/${filename}