@aws-cdk/aws-codestarnotifications

中文文档
1.204.0发布于 2023/06/20Apache-2.0TypeScriptCommonJS近 30 天下载 27.7万

AWS 的 CDK 构建库:: 代码星际通告

此软件包已被标记为弃用

AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2. For more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html

中文使用文档
文档目录5 节
  1. 通知规则
  2. 通知目标
  3. 实例
  4. 通知来源
  5. 活动

AWS 代码星际通告构建库


End-of-Support

AWS CDK v1在2023-06-01上达到了支持结束. 此软件包不再更新,用户应该迁移到 AWS CDK v2.

关于如何移徙的更多信息,请参见: 移动到 AWS CDK v2 指南。 。 。 .


这个模块是 AWS 云开发套件 项目.

通知规则

这个 NotificationRule 构造定义了 AWS 代码星际通告规则. 规则指定要通知的事件和目标 (如亚马逊SNS主题或为 Slack 配置的 AWS Chatbot 客户端) 在那里你想接收他们. 通知目标是指实施 INotificationRuleTarget 接口和通知源是执行 INotificationRuleSource 接口.

通知目标

本单元包括实施 INotificationRuleTarget 在 AWS Chatbot 中为 SNS 和 lap 接口.

支持下列目标:

  • SNS:指定事件并通知SNS主题.
  • AWS Chatbot: 指定事件并通知以松动频道并仅支持 SlackChannelConfiguration。 。 。 .

实例

import * as notifications from '@aws-cdk/aws-codestarnotifications';
import * as codebuild from '@aws-cdk/aws-codebuild';
import * as sns from '@aws-cdk/aws-sns';
import * as chatbot from '@aws-cdk/aws-chatbot';

const project = new codebuild.PipelineProject(this, 'MyProject');

const topic = new sns.Topic(this, 'MyTopic1');

const slack = new chatbot.SlackChannelConfiguration(this, 'MySlackChannel', {
  slackChannelConfigurationName: 'YOUR_CHANNEL_NAME',
  slackWorkspaceId: 'YOUR_SLACK_WORKSPACE_ID',
  slackChannelId: 'YOUR_SLACK_CHANNEL_ID',
});

const rule = new notifications.NotificationRule(this, 'NotificationRule', {
  source: project,
  events: [
    'codebuild-project-build-state-succeeded',
    'codebuild-project-build-state-failed',
  ],
  targets: [topic],
});
rule.addTarget(slack);

通知来源

本单元包括实施 INotificationRuleSource aWS 代码构建的接口, AWS CodePipeline 并在未来支持AWS CodeCommit,AWS CodeDepplop.

支持以下来源:

  • AWS CodeBuild: 支持代码构建项目,以便在指定事件时触发通知.
  • AWS CodePipeline: 在指定事件时支持代码管以触发通知.

活动

关于 CodeBuild 和 CodePipeline 支持的事件类型的完整列表,请参见:

版本与发布记录

@aws-cdk/aws-codestarnotifications 共发布 220 个版本,首次发布于 2019/11/19;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.204.0latest2023/06/203 年前
1.203.02023/06/013 年前
1.202.02023/05/223 年前
1.201.02023/05/113 年前
1.200.02023/04/273 年前
1.199.02023/04/213 年前

关于 @aws-cdk/aws-codestarnotifications 的常见问题

@aws-cdk/aws-codestarnotifications 是什么?

AWS 的 CDK 构建库:: 代码星际通告注意:该包已被作者标记为弃用——AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2. For more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html

如何安装 @aws-cdk/aws-codestarnotifications?

在项目目录运行 npm install @aws-cdk/aws-codestarnotifications,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@aws-cdk/core(1.204.0)、constructs(^3.3.69)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@aws-cdk/aws-codestarnotifications 支持 TypeScript 吗?

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

@aws-cdk/aws-codestarnotifications 支持 ESM 还是 CommonJS?

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

@aws-cdk/aws-codestarnotifications 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >= 14.15.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@aws-cdk/aws-codestarnotifications 可以商用吗?

@aws-cdk/aws-codestarnotifications 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@aws-cdk/aws-codestarnotifications 的下载量有多少?

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

@aws-cdk/aws-codestarnotifications 还在维护吗?

最新版本 1.204.0 发布于 2023/06/20(3 年前);至今共发布 220 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/11/19。作者已将其标记为弃用,新项目建议寻找替代方案。