Releases
扩展 AbstractPackageJoomla 平台的 GitHub API 参考类。
| 链接 | |
|---|---|
| 自 |
1.1.0 |
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
__get
延迟创建 API 对象的魔术方法
__get( name) : \Joomla\Github\AbstractPackage
create
创建发布。
create( user, repo, tagName, targetCommitish = '', name = '', body = '', draft = false, preRelease = false) :
| 链接 | |
|---|---|
| 自 |
1.1.0 |
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 标签名称
string标签的名称。- 目标提交
string确定从何处创建 Git 标签的提交值。- 名称
string发布的名称。- 主体
string描述标签内容的文本。- 草稿
boolTrue 表示创建草稿（未发布）发布，False 表示创建已发布发布。- 预发布
boolTrue 表示将发布标识为预发布，False 表示将发布标识为完整发布。
响应
对象
delete
删除发布。
delete( owner, repo, releaseId) :
| 自 |
1.4.0 |
|---|
参数
- 所有者
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 发布 ID
int发布 ID。
响应
对象
deleteAsset
删除发布资产。
deleteAsset( user, repo, assetId) :
| 自 |
1.4.0 |
|---|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 资产 ID
int资产 ID。
响应
bool
edit
编辑发布。
edit( user, repo, releaseId, tagName, targetCommitish = null, name = null, body = null, draft = null, preRelease = null) :
| 链接 | |
|---|---|
| 自 |
1.1.0 |
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 发布 ID
int发布 ID。- 标签名称
string标签的名称。- 目标提交
string确定从何处创建 Git 标签的提交值。- 名称
string您希望将更改拉入的分支（或 Git ref）。这应该是在当前存储库中的现有分支。您不能向一个存储库提交拉取请求，该请求请求合并到另一个存储库的基线。- 主体
bool新拉取请求的主体文本。- 草稿
bool实现更改的分支（或 Git ref）。- 预发布
string实现更改的分支（或 Git ref）。
响应
对象
editAsset
编辑发布资产。
editAsset( user, repo, assetId, name, label = '') :
| 自 |
1.4.0 |
|---|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 资产 ID
int资产 ID。- 名称
string资产的文件名。- 标签
string资产的替代简短描述。用作文件名替代。
响应
对象
fetchUrl
用于构建和返回请求的完整请求 URL 的方法。此方法将在必要时添加适当的分页详细信息，并将 API URL 添加到请求 URL 的开头，以形成完整的请求 URL。
fetchUrl( path, page, limit) : \Joomla\Uri\Uri
get
获取单个发布。
get( user, repo, ref) :
| 自 |
1.1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 参考
string有效值包括：'latest'、'tags/2.0.24' 或发布 ID，例如：'1643513'
响应
对象
getAsset
获取单个发布资产。
getAsset( user, repo, assetId) :
| 自 |
1.4.0 |
|---|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 资产 ID
int资产 ID。
响应
对象
getByTag
按标签名称获取发布。
getByTag( user, repo, tag) :
| 自 |
1.4.0 |
|---|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 标签
string标签的名称。
响应
对象
getLatest
获取最新发布。
getLatest( user, repo) :
查看存储库的最新已发布完整发布。此端点不返回草稿发布和预发布。
| 自 |
1.4.0 |
|---|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。
响应
对象
getList
列出存储库的发布。
getList( user, repo, page, limit) : mixed||string|int
| 自 |
1.1.0 |
|---|---|
| 抛出 |
|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 页面
int获取项目的页码。- 限制
int每页的项目数量。
响应
array<string|int, mixed>按标签名称作为键的发布的关联数组。
getListAssets
列出发布的资产。
getListAssets( user, repo, releaseId, page, limit) :
| 自 |
1.4.0 |
|---|
参数
- 用户
stringGitHub 存储库所有者的名称。- 仓库
stringGitHub 存储库的名称。- 发布 ID
int发布 ID。- 页面
int获取项目的页码。- 限制
int每页的项目数量。
响应
对象
processResponse
处理响应并对其进行解码。
processResponse(\Joomla\Http\Response response, expectedCode = 200) :
属性
包
对象所在的包
| 自 |
1.0 |
|---|
类型
string
hookEvents
包含允许的钩子事件的数组
| 自 |
1.5.2 |
|---|---|
| 链接 | |
| 注意 |
从 1.4.0 到 1.5.1，此名称为 $events，由于与包子类发生命名冲突，因此更名为 $events |
类型
array<string|int, mixed>