# @amazon-codecatalyst/blueprint-component\.workflows 中文文档

规范地址：https://npmcn.com/package/%40amazon-codecatalyst/blueprint-component.workflows/

版本：0\.3\.159
npm 元数据更新时间：2026-08-24T15:16:51.337Z
中文译文更新时间：2026-11-06T02:00:14.191Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：176 kB，49 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：@amazon-codecatalyst/blueprint-component\.environments \*，@amazon-codecatalyst/blueprint-component\.source-repositories \*，@amazon-codecatalyst/blueprints\.blueprint \*，projen \*
- 首次发布：2023-09-26T14:41:10.421Z
- 最新版本发布：2026-08-24T15:16:51.124Z
- 近 30 天下载量：6799（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：159（近 12 个月 4 个）

## 中文简介

这是一个代码解析工作流程的表示.

## 安装

```sh
npm install @amazon-codecatalyst/blueprint-component.workflows
```

也可以使用：`pnpm add @amazon-codecatalyst/blueprint-component.workflows`、`yarn add @amazon-codecatalyst/blueprint-component.workflows`、`bun add @amazon-codecatalyst/blueprint-component.workflows`

## README

```
import {...} from '@amazon-codecatalyst/blueprint-component.workflows'
```

可找到工作流程组件 [这里](https://github.com/aws/codecatalyst-blueprints/tree/main/packages/components/workflows)。 。 。 .

## 什么是工作流程组成部分?

CodeCatalyst项目使用一个工作流程来执行一些基于触发的动作. 蓝图团队披露了一些有用的工作流程组件 帮助建立和整理工作流程的 yaml 文件。 见 [公开工作流程文件](https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflow-reference.html) 用于一般用途.

```
import { WorkflowBuilder, Workflow } from '@amazon-codecatalyst/blueprint-component.workflows'
```

### 例1:工作流程构建组件

这是一个帮助构建工作流程定义的类. 然后,这可以交给一个工作流程组件,以便在存储器中渲染.

```
import { WorkflowBuilder } from '@amazon-codecatalyst/blueprint-component.workflows'

const workflowBuilder = new WorkflowBuilder({} as Blueprint, {
  Name: 'my_workflow',
});

// trigger the workflow on pushes to branch 'main'
workflowBuilder.addBranchTrigger(['main']);

// add a build action
workflowBuilder.addBuildAction({
  // give the action a name
  actionName: 'build_and_do_some_other_stuff',

  // the action pulls from source code
  input: {
    Sources: ['WorkflowSource'],
  },

  // the output attempts to autodiscover test reports, but not in the node modules
  output: {
    AutoDiscoverReports: {
      Enabled: true,
      ReportNamePrefix: AutoDiscovered,
      IncludePaths: ['**/*'],
      ExcludePaths: ['*/node_modules/**/*'],
    },
  },
  // execute some arbitrary steps
  steps: [
    'npm install',
    'npm run myscript',
    'echo hello-world',
  ],
  // add an account connection to the workflow
  environment: convertToWorkflowEnvironment(myEnv),
});
```

### 例2:工作流程 projen 组件

这是一个 projen 组件,将一个工作流程 yaml 写入一个寄存器 .

```
import { Workflow } from '@amazon-codecatalyst/blueprint-component.workflows'

...

const repo = new SourceRepository
const blueprint = this;
const workflowDef = workflowBuilder.getDefinition()

// creates a workflow.yaml at .aws/workflows/${workflowDef.name}.yaml
new Workflow(blueprint, repo, workflowDef);

// can also pass in any object and have it rendered as a yaml. This is unsafe and may not produce a valid workflow
new Workflow(blueprint, repo, {... some object ...});

```

## 连接到环境

许多工作流程需要在AWS账户连接中运行. 工作流程通过允许行动与环境连接,与会计和 角色名称规范.

```
import { convertToWorkflowEnvironment } from '@amazon-codecatalyst/blueprint-component.workflows'


const myEnv = new Environment(...);

// can be passed into a workflow constructor
const workflowEnvironment = convertToWorkflowEnvironment(myEnv);


// add a build action
workflowBuilder.addBuildAction({
  ...
  // add an account connection to the workflow
  environment: convertToWorkflowEnvironment(myEnv),
});
```

## 常见问题

### @amazon-codecatalyst/blueprint-component\.workflows 是什么？

这是一个代码解析工作流程的表示\.

### 如何安装 @amazon-codecatalyst/blueprint-component\.workflows？

在项目目录运行 npm install @amazon-codecatalyst/blueprint-component\.workflows，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@amazon-codecatalyst/blueprint-component\.environments（\*）、@amazon-codecatalyst/blueprint-component\.source-repositories（\*）、@amazon-codecatalyst/blueprints\.blueprint（\*）、projen（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @amazon-codecatalyst/blueprint-component\.workflows 支持 TypeScript 吗？

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

### @amazon-codecatalyst/blueprint-component\.workflows 支持 ESM 还是 CommonJS？

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

### @amazon-codecatalyst/blueprint-component\.workflows 可以商用吗？

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

### @amazon-codecatalyst/blueprint-component\.workflows 的下载量有多少？

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

### @amazon-codecatalyst/blueprint-component\.workflows 还在维护吗？

最新版本 0\.3\.159 发布于 2026/08/24（2 个月前）；至今共发布 159 个版本，其中过去 12 个月发布了 4 个；首次发布于 2023/09/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。