净化云
这个包提供了一种代理工具,用于从 Git 寄存器中部署站点,列出站点,配置自定义域,并通过Netlify REST API管理环境变量.
安装
npm install @framers/agentos-ext-cloud-netlify
同伴依赖 : @framers/agentos >=0.10.40。 。 。 .
使用量
import { AgentOS } from '@framers/agentos';
const agentos = await AgentOS.create({
extensionManifest: {
packs: [
{
package: '@framers/agentos-ext-cloud-netlify',
options: {
token: process.env.NETLIFY_AUTH_TOKEN ?? process.env.NETLIFY_TOKEN,
},
},
],
},
});
配置
| 选项 | 秘密编号 | 环境变量 | 需求 | 默认 |
|---|---|---|---|---|
token | netlify.token | NETLIFY_AUTH_TOKEN,则 NETLIFY_TOKEN | 对 | 空字符串 |
secrets | netlify.token | 无 | 没有 | A. 背景情况 secrets空对象 |
符号解析自 options.token,然后是环境变量. options.secrets 优先于上下文 secrets。 。 。 .
工具
| 工具 | 它会做什么 |
|---|---|
netlifyDeploySite | 从 Git 寄存器 URL 中部署一个站点, 如果不存在则创建站点 . |
netlifyListSites | 列出有名称、 URL 、 Git 寄存器、 自定义域和部署状态的账户站点 . |
netlifyConfigureDomain | 处理自定义域动作并返回 DNS 设置指令. |
netlifySetEnvVars | 设置或列出具有上下文定义的站点环境变量. |
netlifyDeploySite
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
gitUrl | 字符串 | 对 | Git 仓库 URL . |
siteName | 字符串 | 没有 | 全球独有的Netlify站点名,如果省略则取自仓库名. |
buildCommand | 字符串 | 没有 | 构建命令. |
publishDirectory | 字符串 | 没有 | 发布目录, 例如 dist, (中文(简体) ), build, (中文(简体) ), public,或 .next。 。 。 . |
branch | 字符串 | 没有 | 要部署的 Git 分支, 默认值 : main。 。 。 . |
envVars | 对象 | 没有 | 站点环境变量作为键值对. |
netlifyListSites
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
limit | 编号 | 没有 | 返回最多地点 . |
netlifyConfigureDomain
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
siteId | 字符串 | 对 | 网易站点标识或名称. |
domain | 字符串 | 对 | 自定义域, 例如 example.com 或者说 www.example.com。 。 。 . |
action | 字符串 | 没有 | add, (中文(简体) ), remove, (中文(简体) ), list,或 check; 默认 : add。 。 。 . |
netlifySetEnvVars
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
siteId | 字符串 | 对 | 网易站点标识或名称. |
vars | 对象 | 没有 | 要设置的环境变量键值对 . |
action | 字符串 | 没有 | set 或者说 list; 默认 : set。 。 。 . |
context | 字符串 | 没有 | 部署背景: all, (中文(简体) ), dev, (中文(简体) ), branch-deploy, (中文(简体) ), deploy-preview,或 production; 默认 : all。 。 。 . |
页:1
激活需要Netlify个人访问符. 如果缺少该令牌或当前用户认证请求失败,则失败 .
Git URL 解析器接受 GitHub, GitLab, 和 Bitbucket URLs. 部署重新使用一个按名称发现的站点,或者在搜索失败时试图创建站点. 存储库和构建设置在创建站点时被传递. 该工具触发了部署,并在不等待完成的情况下返回状态.
部署,域配置,以及环境变量会修改远程资源. 域设置返回 DNS 指令; 它不创建 DNS 记录 。 这个 check 动作读取 Netlify DNS 区域和记录.
这个 remove 动作将一个空自定义域传递给服务,但服务从更新请求中省略了空值. 该工具报告删除时没有发送一个域清除字段.
设置环境变量需要非空 vars 对象。 以账户 sattle,变量使用账户环境 API和所选上下文. 没有账户 swit, 写回站点构建设置并省略上下文范围 。 列出 API 提供的返回值。 站点映射器省略了构建环境值,因此列出倒置的构建设置返回了空数组.
许可证
阿帕奇 - 2.0