[](https://github.com/cloudcomponents/cdk-constructs)
# @cloudcomponents/cdk-developer-tools-notifications
[](https://github.com/cloudcomponents/cdk-constructs/actions?query=workflow=Build)
[](https://github.com/hupe1980/cdkdx)
[](https://www.npmjs.com/package/@cloudcomponents/cdk-developer-tools-notifications)
[](https://pypi.org/project/cloudcomponents.cdk-developer-tools-notifications/)
[](https://github.com/kolomied/awesome-cdk)
> #slack / msteams / email notifications for developer tools: CodeCommit, CodeBuild, CodeDeploy, CodePipeline
## Install
TypeScript/JavaScript:
```bash
npm i @cloudcomponents/cdk-developer-tools-notifications
```
Python:
```bash
pip install cloudcomponents.cdk-developer-tools-notifications
```
## MSTeams
[Add incoming webhook](https://docs.microsoft.com/de-de/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook):
1. Navigate to the channel where you want to add the webhook and select (•••) More Options from the top navigation bar.
2. Choose Connectors from the drop-down menu and search for Incoming Webhook.
3. Select the Configure button, provide a name, and, optionally, upload an image avatar for your webhook.
4. The dialog window will present a unique URL that will map to the channel. Make sure that you copy and save the URL—you will need to provide it to the outside service.
5. Select the Done button. The webhook will be available in the team channel.
## #Slack
[Notifications for AWS developer tools](https://docs.aws.amazon.com/chatbot/latest/adminguide/related-services.html#codeserviceevents)
## How to use
```python
import { SlackChannelConfiguration, MSTeamsIncomingWebhookConfiguration, AccountLabelMode } from '@cloudcomponents/cdk-chatops';
import {
RepositoryNotificationRule,
PipelineNotificationRule,
RepositoryEvent,
PipelineEvent,
SlackChannel,
MSTeamsIncomingWebhook,
} from '@cloudcomponents/cdk-developer-tools-notifications';
import { Stack, StackProps } from 'aws-cdk-lib';
import { Repository } from 'aws-cdk-lib/aws-codecommit';
import { Pipeline, Artifact } from 'aws-cdk-lib/aws-codepipeline';
import { CodeCommitSourceAction, ManualApprovalAction } from 'aws-cdk-lib/aws-codepipeline-actions';
import { Construct } from 'constructs';
export class NotificationsStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
const repository = new Repository(this, 'Repository', {
repositoryName: 'notifications-repository',
});
if (typeof process.env.SLACK_WORKSPACE_ID === 'undefined') {
throw new Error('environment variable SLACK_WORKSPACE_ID undefined');
}
if (typeof process.env.SLACK_CHANNEL_ID === 'undefined') {
throw new Error('environment variable SLACK_CHANNEL_ID undefined');
}
const slackChannel = new SlackChannelConfiguration(this, 'SlackChannel', {
slackWorkspaceId: process.env.SLACK_WORKSPACE_ID,
configurationName: 'notifications',
slackChannelId: process.env.SLACK_CHANNEL_ID,
});
if (typeof process.env.INCOMING_WEBHOOK_URL === 'undefined') {
throw new Error('environment variable INCOMING_WEBHOOK_URL undefined');
}
const webhook = new MSTeamsIncomingWebhookConfiguration(this, 'MSTeamsWebhook', {
url: process.env.INCOMING_WEBHOOK_URL,
accountLabelMode: AccountLabelMode.ID_AND_ALIAS,
themeColor: '#FF0000',
});
new RepositoryNotificationRule(this, 'RepoNotifications', {
name: 'notifications-repository',
repository,
events: [RepositoryEvent.COMMENTS_ON_COMMITS, RepositoryEvent.PULL_REQUEST_CREATED, RepositoryEvent.PULL_REQUEST_MERGED],
targets: [new SlackChannel(slackChannel), new MSTeamsIncomingWebhook(webhook)],
});
const sourceArtifact = new Artifact();
const sourceAction = new CodeCommitSourceAction({
actionName: 'CodeCommit',
repository,
output: sourceArtifact,
});
const approvalAction = new ManualApprovalAction({
actionName: 'Approval',
});
const pipeline = new Pipeline(this, 'Pipeline', {
pipelineName: 'notifications-pipeline',
stages: [
{
stageName: 'Source',
actions: [sourceAction],
},
{
stageName: 'Approval',
actions: [approvalAction],
},
],
});
new PipelineNotificationRule(this, 'PipelineNotificationRule', {
name: 'pipeline-notification',
pipeline,
events: [
PipelineEvent.PIPELINE_EXECUTION_STARTED,
PipelineEvent.PIPELINE_EXECUTION_FAILED,
PipelineEvent.PIPELINE_EXECUTION_SUCCEEDED,
// PipelineEvent.ACTION_EXECUTION_STARTED,
// PipelineEvent.ACTION_EXECUTION_SUCCEEDED,
// PipelineEvent.ACTION_EXECUTION_FAILED,
PipelineEvent.MANUAL_APPROVAL_NEEDED,
PipelineEvent.MANUAL_APPROVAL_SUCCEEDED,
// PipelineEvent.MANUAL_APPROVAL_FAILED,
// PipelineEvent.STAGE_EXECUTION_STARTED,
// PipelineEvent.STAGE_EXECUTION_SUCCEEDED,
// PipelineEvent.STAGE_EXECUTION_FAILED,
],
targets: [new SlackChannel(slackChannel), new MSTeamsIncomingWebhook(webhook)],
});
}
}
```
## API Reference
See [API.md](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-developer-tools-notifications/API.md).
## Example
See more complete [examples](https://github.com/cloudcomponents/cdk-constructs/tree/master/examples).
## License
[MIT](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-developer-tools-notifications/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/cloudcomponents/cdk-constructs",
"name": "cloudcomponents.cdk-developer-tools-notifications",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "hupe1980",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1d/28/55abd631951b918087a5ecd00d7dfa1b2762c41a7f6f9f58ac45d8f7f2c0/cloudcomponents.cdk-developer-tools-notifications-2.3.0.tar.gz",
"platform": null,
"description": "[](https://github.com/cloudcomponents/cdk-constructs)\n\n# @cloudcomponents/cdk-developer-tools-notifications\n\n[](https://github.com/cloudcomponents/cdk-constructs/actions?query=workflow=Build)\n[](https://github.com/hupe1980/cdkdx)\n[](https://www.npmjs.com/package/@cloudcomponents/cdk-developer-tools-notifications)\n[](https://pypi.org/project/cloudcomponents.cdk-developer-tools-notifications/)\n[](https://github.com/kolomied/awesome-cdk)\n\n> #slack / msteams / email notifications for developer tools: CodeCommit, CodeBuild, CodeDeploy, CodePipeline\n\n## Install\n\nTypeScript/JavaScript:\n\n```bash\nnpm i @cloudcomponents/cdk-developer-tools-notifications\n```\n\nPython:\n\n```bash\npip install cloudcomponents.cdk-developer-tools-notifications\n```\n\n## MSTeams\n\n[Add incoming webhook](https://docs.microsoft.com/de-de/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook):\n\n1. Navigate to the channel where you want to add the webhook and select (\u2022\u2022\u2022) More Options from the top navigation bar.\n2. Choose Connectors from the drop-down menu and search for Incoming Webhook.\n3. Select the Configure button, provide a name, and, optionally, upload an image avatar for your webhook.\n4. The dialog window will present a unique URL that will map to the channel. Make sure that you copy and save the URL\u2014you will need to provide it to the outside service.\n5. Select the Done button. The webhook will be available in the team channel.\n\n\n\n## #Slack\n\n[Notifications for AWS developer tools](https://docs.aws.amazon.com/chatbot/latest/adminguide/related-services.html#codeserviceevents)\n\n## How to use\n\n```python\nimport { SlackChannelConfiguration, MSTeamsIncomingWebhookConfiguration, AccountLabelMode } from '@cloudcomponents/cdk-chatops';\nimport {\n RepositoryNotificationRule,\n PipelineNotificationRule,\n RepositoryEvent,\n PipelineEvent,\n SlackChannel,\n MSTeamsIncomingWebhook,\n} from '@cloudcomponents/cdk-developer-tools-notifications';\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { Repository } from 'aws-cdk-lib/aws-codecommit';\nimport { Pipeline, Artifact } from 'aws-cdk-lib/aws-codepipeline';\nimport { CodeCommitSourceAction, ManualApprovalAction } from 'aws-cdk-lib/aws-codepipeline-actions';\nimport { Construct } from 'constructs';\n\nexport class NotificationsStack extends Stack {\n constructor(scope: Construct, id: string, props?: StackProps) {\n super(scope, id, props);\n\n const repository = new Repository(this, 'Repository', {\n repositoryName: 'notifications-repository',\n });\n\n if (typeof process.env.SLACK_WORKSPACE_ID === 'undefined') {\n throw new Error('environment variable SLACK_WORKSPACE_ID undefined');\n }\n if (typeof process.env.SLACK_CHANNEL_ID === 'undefined') {\n throw new Error('environment variable SLACK_CHANNEL_ID undefined');\n }\n const slackChannel = new SlackChannelConfiguration(this, 'SlackChannel', {\n slackWorkspaceId: process.env.SLACK_WORKSPACE_ID,\n configurationName: 'notifications',\n slackChannelId: process.env.SLACK_CHANNEL_ID,\n });\n\n if (typeof process.env.INCOMING_WEBHOOK_URL === 'undefined') {\n throw new Error('environment variable INCOMING_WEBHOOK_URL undefined');\n }\n const webhook = new MSTeamsIncomingWebhookConfiguration(this, 'MSTeamsWebhook', {\n url: process.env.INCOMING_WEBHOOK_URL,\n accountLabelMode: AccountLabelMode.ID_AND_ALIAS,\n themeColor: '#FF0000',\n });\n\n new RepositoryNotificationRule(this, 'RepoNotifications', {\n name: 'notifications-repository',\n repository,\n events: [RepositoryEvent.COMMENTS_ON_COMMITS, RepositoryEvent.PULL_REQUEST_CREATED, RepositoryEvent.PULL_REQUEST_MERGED],\n targets: [new SlackChannel(slackChannel), new MSTeamsIncomingWebhook(webhook)],\n });\n\n const sourceArtifact = new Artifact();\n\n const sourceAction = new CodeCommitSourceAction({\n actionName: 'CodeCommit',\n repository,\n output: sourceArtifact,\n });\n\n const approvalAction = new ManualApprovalAction({\n actionName: 'Approval',\n });\n\n const pipeline = new Pipeline(this, 'Pipeline', {\n pipelineName: 'notifications-pipeline',\n stages: [\n {\n stageName: 'Source',\n actions: [sourceAction],\n },\n {\n stageName: 'Approval',\n actions: [approvalAction],\n },\n ],\n });\n\n new PipelineNotificationRule(this, 'PipelineNotificationRule', {\n name: 'pipeline-notification',\n pipeline,\n events: [\n PipelineEvent.PIPELINE_EXECUTION_STARTED,\n PipelineEvent.PIPELINE_EXECUTION_FAILED,\n PipelineEvent.PIPELINE_EXECUTION_SUCCEEDED,\n // PipelineEvent.ACTION_EXECUTION_STARTED,\n // PipelineEvent.ACTION_EXECUTION_SUCCEEDED,\n // PipelineEvent.ACTION_EXECUTION_FAILED,\n PipelineEvent.MANUAL_APPROVAL_NEEDED,\n PipelineEvent.MANUAL_APPROVAL_SUCCEEDED,\n // PipelineEvent.MANUAL_APPROVAL_FAILED,\n // PipelineEvent.STAGE_EXECUTION_STARTED,\n // PipelineEvent.STAGE_EXECUTION_SUCCEEDED,\n // PipelineEvent.STAGE_EXECUTION_FAILED,\n ],\n targets: [new SlackChannel(slackChannel), new MSTeamsIncomingWebhook(webhook)],\n });\n }\n}\n```\n\n## API Reference\n\nSee [API.md](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-developer-tools-notifications/API.md).\n\n## Example\n\nSee more complete [examples](https://github.com/cloudcomponents/cdk-constructs/tree/master/examples).\n\n## License\n\n[MIT](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-developer-tools-notifications/LICENSE)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "#slack / msteams / email notifications for developer tools: CodeCommit, CodeBuild, CodeDeploy, CodePipeline",
"version": "2.3.0",
"project_urls": {
"Homepage": "https://github.com/cloudcomponents/cdk-constructs",
"Source": "https://github.com/cloudcomponents/cdk-constructs.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "21092d7c7f2930ec510260f278f760e8c5fc15bb15afb159bfc7679eedc37604",
"md5": "d3ce7c8b13ac0b9d31857469d32d26d3",
"sha256": "8031aa3f5f5450e23680a4bf6118fd3f7a12e2246c60a3c4bcd2f40c7a6fe12d"
},
"downloads": -1,
"filename": "cloudcomponents.cdk_developer_tools_notifications-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3ce7c8b13ac0b9d31857469d32d26d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 93195,
"upload_time": "2024-04-17T18:36:31",
"upload_time_iso_8601": "2024-04-17T18:36:31.050765Z",
"url": "https://files.pythonhosted.org/packages/21/09/2d7c7f2930ec510260f278f760e8c5fc15bb15afb159bfc7679eedc37604/cloudcomponents.cdk_developer_tools_notifications-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1d2855abd631951b918087a5ecd00d7dfa1b2762c41a7f6f9f58ac45d8f7f2c0",
"md5": "be5b61d20539a654680630f66334ba69",
"sha256": "be95766d1a802300e5b9f61d8327304a821e7a85b8848097acec17994f432a98"
},
"downloads": -1,
"filename": "cloudcomponents.cdk-developer-tools-notifications-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "be5b61d20539a654680630f66334ba69",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 94664,
"upload_time": "2024-04-17T18:36:44",
"upload_time_iso_8601": "2024-04-17T18:36:44.034741Z",
"url": "https://files.pythonhosted.org/packages/1d/28/55abd631951b918087a5ecd00d7dfa1b2762c41a7f6f9f58ac45d8f7f2c0/cloudcomponents.cdk-developer-tools-notifications-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 18:36:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cloudcomponents",
"github_project": "cdk-constructs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cloudcomponents.cdk-developer-tools-notifications"
}
JSON
