5 CI 公用事业
用户数 电脑编辑 5 CI建设.
包含从 Circle CI 和 GitHub 动作工作流程发送 Slack 通知的工具 .
可用的脚本
这些命令接受环境变量和命令行参数的组合. 当值来自 CI 环境或敏感(像符等)时,环境变量优先. 当值为静态或局部到给定寄存器时,命令行参数优先.
[尖叫声] Tokens作为环境变量被传递,以避免在 shell 历史, CI 日志,或共享配置文件中暴露出敏感的证书.
-
⚙️
ckeditor5-dev-ci-circle-disable-auto-cancel-builds禁用 “自动终止冗余工作流程” 选项. 在发布过程中有用地防止CircleCI取消发布所触发的工作流程,承诺自己.
环境变量:
CKE5_CIRCLE_TOKEN—— CircleCI API 令牌用于认证.
参数:
--organization——GitHub组织名称.--repository—— GitHub 仓库名.
-
⚙️
ckeditor5-dev-ci-circle-enable-auto-cancel-builds启用 “自动终止冗余工作流程” 选项. 应在发布工作流程使用此选项后使用
ckeditor5-dev-ci-circle-disable-auto-cancel-builds剧本.环境变量:
CKE5_CIRCLE_TOKEN—— CircleCI API 令牌用于认证.
参数:
--organization——GitHub组织名称.--repository—— GitHub 仓库名.
-
⚙️
ckeditor5-dev-ci-circle-workflow-notifier等待所有的工作在 当前 CircleCI 工作流程 以完成(成功或出错),然后运行最终命令("通知"). 打算作为一个 专职工作 在你的工作流程中。 脚本本身处理等待 - 您通常不添加
requires这工作.环境变量:
CKE5_CIRCLE_TOKEN—— CircleCI API 令牌用于认证.
CircleCI 提供的变量 :
CIRCLE_WORKFLOW_ID——当前工作流程标识.CIRCLE_JOB——当前工作名称.
参数:
--task——在结尾执行的命令;默认:pnpm ckeditor5-dev-ci-notify-circle-status。 。 。 .--ignore——等待时忽略的任务名(可重复;可以多次传递).
行为:
- 返回瞬变圆 CI API 出错至 5次尝试 带有 10s 延迟 尝试之间.
- 对不可重试的 API 错误( 例如: 无效的令牌或错误的工作流程 ID) 立即失败 .
- 如果瞬间出错持续存在,则退出时会发出明确的信息,要求手动核实工作流程结果.
-
⚙️
ckeditor5-dev-ci-is-job-triggered-by-member证明:a CircleCI 批准任务 由属于指定的 GitHub 团队的用户批准. 使用CircleCI和GitHub APIs来对照团队成员来检查批准者.
环境变量:
CKE5_CIRCLE_TOKEN—— CircleCI API 令牌用于认证.CKE5_GITHUB_TOKEN—— GitHub 令牌用于查询团队成员.
CircleCI 提供的变量 :
CIRCLE_WORKFLOW_ID——当前工作流程标识.
参数:
--job——负责核实的审批工作名称.--organization——GitHub组织名称.--team—— GitHub 团队名称( slug) 以验证对手.
-
⚙️
ckeditor5-dev-ci-is-workflow-restarted检查当前 CircleCI 工作流程是否已经 重新启动。 。 。 . 如果检测到重启,则脚本会以零出站代码退出,允许管道有条件地继续.
环境变量:
CKE5_CIRCLE_TOKEN—— CircleCI API 令牌用于认证.
CircleCI 提供的变量 :
CIRCLE_WORKFLOW_ID——当前工作流程的ID(由CircleCI设置).
-
⚙️
ckeditor5-dev-ci-notify-circle-status发送 Slack 通知,总结当前 CircleCI 构建/工作流程状态 . 对于失败的构建, 请通过 GitHub API( 使用私人寄存器的工作) 获取执行作者 .
环境变量:
CKE5_GITHUB_TOKEN- GitHub 符号与repo范围,用于获取执行作者.CKE5_CIRCLE_TOKEN—— CircleCI API 令牌用于API调用.CKE5_SLACK_WEBHOOK_URL——Webhook URL进入Slack频道接收通知.
CircleCI 提供的变量 :
CIRCLE_BRANCH——目前建筑的编号.CIRCLE_PROJECT_REPONAME——仓库名.CIRCLE_PROJECT_USERNAME- 组织/用户名称.CIRCLE_SHA1- 提交当前建筑的SHA.CIRCLE_WORKFLOW_ID——当前工作流程标识.
参数:
--pipeline-id圆形值( M)<< pipeline.number >>参数(更多信息) (中文(简体) ).--trigger-repository-slug—— 说<org>/<repo>构建承诺 URL--trigger-commit-hash。当管道通过另一个仓库被触发时有用.--trigger-commit-hash——承诺SHA构建承诺URL. 当管道通过不同的存储器被触发时有用 .--hide-author—— 说"true"编号 :"false"把作者藏在斯莱克.
-
⚙️
ckeditor5-dev-ci-notify-github-actions-status发送 Slack 通知, 总结当前 GitHub 动作工作流程运行 . 设计为从门将(或专用工作)调用
if: failure();脚本在发送通知前不检查工作流程状态. 通过 GitHub API( 使用私有寄存器的工作) 获取任务作者和工作流程运行启动时间 .环境变量:
CKE5_GITHUB_TOKEN- GitHub 符号与repo范围,用于获取承诺作者和工作流程运行元数据.CKE5_SLACK_WEBHOOK_URL——Webhook URL进入Slack频道接收通知.
GitHub 提供的变量 :
GITHUB_REPOSITORY—— 说<owner>/<repo>当前工作流程.GITHUB_REF_NAME- 触发工作流程的分支或标签名称.GITHUB_SHA提交当前运行的 SHA .GITHUB_RUN_ID——当前工作流程运行的标识.GITHUB_RUN_ATTEMPT—— 说 (备选) 运行尝试编号; 当大于1。 。 。 .GITHUB_WORKFLOW—— 说 (备选) 显示当前工作流程的名称 .GITHUB_SERVER_URL—— 说 (备选) 服务器 URL; 默认为https://github.com。 。 。 .GITHUB_API_URL—— 说 (备选) API 基础 URL; 默认为https://api.github.com。 。 。 .
参数:
--trigger-repository-slug—— 说<org>/<repo>构建承诺 URL--trigger-commit-hash。当工作流程通过不同的存储器被触发时有用.--trigger-commit-hash——承诺SHA构建承诺URL. 当工作流程通过不同的存储器被触发时有用 .--hide-author—— 说"true"编号 :"false"把作者藏在斯莱克.
-
⚙️
ckeditor5-dev-ci-trigger-circle-build触发 a 新 CircleCI 管道 用于指定仓库. 通常用于启动现有工作流程的发布或后续管道.
环境变量:
CKE5_CIRCLE_TOKEN—— CircleCI API 令牌用于认证.
CircleCI 提供的变量 :
CIRCLE_BRANCH——目前已加工管线的吉特分支.CIRCLE_SHA1——全力投入目前已加工管线的SHA.
参数:
--slug- 储存弹(org/name新管道将在那里开始.--trigger-repository-slug—— 说 (备选) 存储弹( R)org/name这引发了新的管道. 如果匹配, 可以省略--slug。 。 。 .--release-branch—— 说 (备选) 领导放行过程的分会.--pipeline-definition-id—— 说 (备选) GitHub App 管道定义 ID. 在提供时,指定管道 定义被触发,而不是项目默认的 OAuth 管道.
-
⚙️
ckeditor5-dev-ci-trigger-snyk-scan为当前分支发布 Snyk 代码和依赖快照 . 它配置 Snyk CLI 以使用欧盟端点和所提供的组织,然后运行
snyk code test财务报告和审定财务报表snyk monitor命令.环境变量:
SNYK_TOKEN——用于认证的斯奈克令牌.DEBUG—— 说 (备选) 设定时, 附加-d改为snyk code test财务报告和审定财务报表snyk monitor用于动词输出,并删除--silent从pnpm引证.
CircleCI 提供的变量 :
CIRCLE_BRANCH-吉特分行作为斯奈克的target-reference。 。 。 .
参数:
--depth—— 说 (备选) 检测深度传递到snyk monitor作为--detection-depth默认为2。 。 。 .--exclude—— 说 (可选,可重复) 附加目录或文件名以排除斯奈克的依赖快照. 使用多次, 例如--exclude=build --exclude=dist。所提供的数值是: 合并 内置默认值( n)external, (中文(简体) ),tests, (中文(简体) ),node_modules, (中文(简体) ),release, (中文(简体) ),scripts) (中文(简体) ).--organization- Snyk组织 身份或子弹.
行为:
- 总是排除
external, (中文(简体) ),tests, (中文(简体) ),node_modules, (中文(简体) ),release财务报告和审定财务报表scripts从依赖性快照检测。 通过--exclude与这些默认合并(重复被忽略). - 通行证
--detection-depth(默认 :2改为:snyk monitor以限制 Snyk 对显示文件的深度扫描,从而避免深度嵌入引起的性能问题node_modules树. - 接受退出代码
1从snyk code test,所以当发现弱点时,代码快照仍然被发布. - 需要退出代码
0从snyk monitor,因为任何其他代码意味着依赖快照没有被创建.
更改日志
见 CHANGELOG.md 文档.
许可证
根据下列规定获得许可证: GNU 通用公共许可证版本 2 或稍后版本请检查date=中的日期值 (帮助) LICENSE.md 文档.