@ action/ github- 命令
GitHub 动作工作流程命令语法作为纯函数: 使命令与跑者逃跑, 并中和文本, 使跑者无法读取为一. 弦入而出,弦出而出. 没有服务,没有一层,没有平台,没有 effect,完全不依赖.
预
1.0.0。 。 。 . 此软件包是@effected/*工具包,仍在0.x发展。 它没有依赖关系,甚至没有effect。 。 。 .稳定:不稳定. 此软件包的 API 表面尚未考虑 完成并可能改变
0.x释放 准确的版本。 满 政策: 释放策略。 。 。 .
为什么 @ effect/ github- commands
跑者读到每一行的书写, 和它识别为命令的一行做命令说: ::add-mask:: 剪辑, ::error:: 提出一个注释, ::stop-commands:: 关闭处理。 文本程序本身没有写入,例如错误消息或文件名,因此可以携带命令. 跑者有两个解析器,所以"从 ::"只有一半的规则: 留下的遗产 ##[ 随时随地.
这个包是写过一次的规则. WorkflowCommand 构建您要写入的命令, 并保存协议需要的 . CommandNeutralizer 解开你无意的文字.
安装
npm install @effected/github-commands
pnpm add @effected/github-commands
需要节点.js~~24.11.0. 无依相相相相相相相相相相相相相相相相相相相相相相相相相. 仅限无害环境管理:从ES模块中导入.
使用量
import { CommandNeutralizer, WorkflowCommand } from "@effected/github-commands";
WorkflowCommand.error("build failed", { file: "src/main.ts", startLine: 12 });
// "::error file=src/main.ts,line=12::build failed"
WorkflowCommand.warning("deprecated: 50% of calls\nuse v2", { title: "API: v1" });
// "::warning title=API%3A v1::deprecated: 50%25 of calls%0Ause v2"
CommandNeutralizer.text("prefix ##[add-mask]secret\n::error::x");
// a braille pattern blank (U+2800) inside the ##[ and before the ::, so neither parser reads a command
WorkflowCommand数字 :render(name, properties, message)编辑debug, (中文(简体) ),notice, (中文(简体) ),warning, (中文(简体) ),error, (中文(简体) ),group, (中文(简体) ),endGroup财务报告和审定财务报表addMask帮手 注释属性使用可读名称( :startLine, (中文(简体) ),startColumn并去作为电线的(line, (中文(简体) ),col) (中文(简体) ). 消息会逃脱%, CR 和 LF; 属性值也逃出:财务报告和审定财务报表,; 数据%先去 所以逃出两次都逃不掉.CommandNeutralizer数字 :lines(text)财务报告和审定财务报表text(text)。一个赤裸的##所以减速方向没有损伤 它像跑者一样在CR,LF和CRLF中分裂出,它具有一能性:中和两次改变什么.
@effected/github-actions 再出口 WorkflowCommand,以及 @effected/cli-kit 中和其输出通过 CommandNeutralizer 当跑者是 GitHub 动作时.
文档
指南和API参考文献在 执行. spencerbeg.gs/github - 命令。 。 。 .