代码数据库工作流程 SDK

说明

一个JavaScript SDK,用于代码Catalyst Workflows.

此 SDK 意在帮助用户创建 亚马逊代码Catalyst 工作流程 提供客户端在输入文件前对工作流程进行实际验证.

安装

要安装此软件包, 只需使用您最喜欢的软件包管理器键入或安装 @aws/codecatalyst-workflows- sdk :

npm install @aws/codecatalyst-workflows-sdk

yarn add @aws/codecatalyst-workflows-sdk

pnpm add @aws/codecatalyst-workflows-sdk

开始

导入

要开始使用 sdk 验证您的工作流程 yaml 文件从客户端导入工作流程定义模块

// es5 example
const { WorkflowDefinition } = require("@aws/codecatalyst-workflows-sdk");

//es6 example
const { WorkflowDefinition } = require("@aws/codecatalyst-workflows-sdk");

使用量

要验证您的工作流程 yaml 文件使用 validate 命令在 WorkflowDefinition 课。 可以找到一个实例 下级

const { WorkflowDefinition } = require("@aws/codecatalyst-workflows-sdk");
const { load } = require("js-yaml");

const workflowYaml = `
Name: PushWorkflow
SchemaVersion: 1.0
Triggers:
  - Type: PULLREQUEST
    Events:
      - "DRAFT"
Actions:
  BackendBuildAndPackage:
    Identifier: aws/build@v1
    Inputs:
      Sources:
        - WorkflowSource
    Outputs:
      Artifacts:
        - Name: backend
          Files:
            - "**/*"
    Configuration:
      Steps:
        - Run: echo "Building Backend Artifacts..."
`

const validationResult = WorkflowDefinition.validate(load(workflowYaml))

得到支持的行动

• aws/ building@v1 (英语)
• aws/ 管理- test@v1
• aws/github-actions-runner@v1 (英语)

许可证

此 SDK 分布于 Apache 许可证,2.0版本,更多信息见LICENSE.