# @aws/codecatalyst-workflows-sdk 中文文档

规范地址：https://npmcn.com/package/%40aws/codecatalyst-workflows-sdk/

版本：0\.1\.5-preview\.6
npm 元数据更新时间：2026-06-19T19:22:06.013Z
中文译文更新时间：2026-11-07T15:39:14.454Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aws/codecatalyst-workflows-sdk
原文对照：https://npmcn.com/package/%40aws/codecatalyst-workflows-sdk/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：254 kB，82 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：projen ^0\.71\.112
- 首次发布：2023-11-16T21:14:00.981Z
- 最新版本发布：2023-11-17T23:57:37.810Z
- 近 30 天下载量：7192（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

这是代码解析器的工作流程 sdk. 这定义了编码解析器项目的工作流程配置 .

## 安装

```sh
npm install @aws/codecatalyst-workflows-sdk
```

也可以使用：`pnpm add @aws/codecatalyst-workflows-sdk`、`yarn add @aws/codecatalyst-workflows-sdk`、`bun add @aws/codecatalyst-workflows-sdk`

## README

# 代码数据库工作流程 SDK

## 说明

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

此 SDK 意在帮助用户创建 [亚马逊代码Catalyst 工作流程](https://docs.aws.amazon.com/codecatalyst/latest/userguide/flows.html) 提供客户端在输入文件前对工作流程进行实际验证.

## 安装

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

```shell
npm install @aws/codecatalyst-workflows-sdk
```

```shell
yarn add @aws/codecatalyst-workflows-sdk
```

```shell
pnpm add @aws/codecatalyst-workflows-sdk
```

## 开始

### 导入

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

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

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

### 使用量

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

```javascript
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版本](https://www.apache.org/licenses/LICENSE-2.0),更多信息见LICENSE.

## 常见问题

### @aws/codecatalyst-workflows-sdk 是什么？

这是代码解析器的工作流程 sdk\. 这定义了编码解析器项目的工作流程配置 \.

### 如何安装 @aws/codecatalyst-workflows-sdk？

在项目目录运行 npm install @aws/codecatalyst-workflows-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：projen（^0\.71\.112）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aws/codecatalyst-workflows-sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aws/codecatalyst-workflows-sdk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @aws/codecatalyst-workflows-sdk 可以商用吗？

@aws/codecatalyst-workflows-sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aws/codecatalyst-workflows-sdk 的下载量有多少？

根据 npm 官方下载统计，@aws/codecatalyst-workflows-sdk 在 2026/10/08 – 2026/11/06 这 30 天内被下载 7,192 次，日均约 240 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aws/codecatalyst-workflows-sdk 还在维护吗？

最新版本 0\.1\.5-preview\.6 发布于 2023/11/18（2 年前）；至今共发布 7 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/11/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。