亚马逊 CodeCatalyst 不再向新买家开放。现有客户可以继续正常使用该服务。有关更多信息，请参阅 [如何从中迁移 CodeCatalyst](migration.md)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 向蓝图添加工作流组件
<a name="comp-workflow-bp"></a>

Amazon CodeCatalyst 项目使用工作流，根据触发器运行操作。您可以使用工作流组件来构建和整理工作流 YAML 文件。有关更多信息，请参阅 [工作流 YAML 定义](workflow-reference.md)。

**导入 Amazon CodeCatalyst 蓝图工作流组件**

在您的 `blueprint.ts` 文件中，添加以下内容：

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

**Topics**
+ [工作流组件示例](#comp-workflows-examples-bp)
+ [连接到环境](#comp-workflows-connect-env-bp)

## 工作流组件示例
<a name="comp-workflows-examples-bp"></a>

### WorkflowBuilder 组件
<a name="comp-workflows-workflowbuilder-bp"></a>

您可以使用类来构建工作流定义。可以为工作流组件提供定义，以便在存储库中进行呈现。

```
import { WorkflowBuilder } from '@amazon-codecatalyst/codecatalyst-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),
});
```

### 工作流 Projen 组件
<a name="comp-workflows-projen-bp"></a>

以下示例说明如何使用 Projen 组件将工作流 YAML 写入到存储库中：

```
import { Workflow } from '@amazon-codecatalyst/codecatalyst-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 ...});
```

## 连接到环境
<a name="comp-workflows-connect-env-bp"></a>

许多工作流需要在 AWS 账户连接中运行。工作流可让操作使用账户和角色名称规范连接到环境，从而处理这种情况。

```
import { convertToWorkflowEnvironment } from '@amazon-codecatalyst/codecatalyst-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),
});
```