动作/工作流程-参数

@actions/workflow-parser 是分析 GitHub 动作的库 工作流程。 。 。 .

安装

这个 软件包 包含TypeScript类型并编译了ECMAScript模块.

npm install @actions/workflow-parser

使用量

解析器是由定义于 worflows-v1.0.json。 。 。 .

简单示例

parseWorkflow 将工作流程 YAML 解析为中间代表,并验证它符合计划。 解析错误在 errors 结果上下文的属性.

var trace: TraceWriter;

const result = parseWorkflow(
  {
    name: "test.yaml",
    content: `on: push
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - run: echo 'hello'`
  },
  trace
);

convertWorkflowTemplate 然后将中间代表转换为 WorkflowTemplate 对象,这是比较方便的工作流程表达.

const workflowTemplate = await convertWorkflowTemplate(result.context, result.value);

// workflowTemplate.jobs[0].id === "build"
// workflowTemplate.jobs[0].steps[0].run === "echo 'hello'"

捐款

见 捐款额 作为一般准则和建议存放处的基础.

类似 `行动/表现',这个项目只是GitHub Actions工作流程解析器的多处执行之一. 因此,我们不能接受大大改变方案或分析者总体行为的贡献。 如果你想对行动本身提出修改,请使用我们 社区论坛。 。 。 .

如果你想捐款,请跑 更美丽 用于格式化您的代码,并在提交您的PR前酌情添加单位测试. ./测试数据 包含所有执行都应通过的测试案例,也请确保这些测试仍然通过.

构建

npm run build

或监视更改

npm run watch

测试

npm test

或监视更改和运行测试:

npm run test-watch

林特

npm run format-check

许可证

这个项目根据麻省理工学院开源许可证的规定获得许可. 请参考 麻省理工学院 全部条件.