Cdk component that provisions a #slack approval workflow and notification messages on codepipeline state changes
Project description
@cloudcomponents/cdk-codepipeline-slack
Cdk component that provisions a #slack approval workflow and notification messages on codepipeline state changes
Install
TypeScript/JavaScript:
npm install --save @cloudcomponents/cdk-codepipeline-slack
Python:
pip install cloudcomponents.cdk-codepipeline-slack
How to use
import { SlackApprovalAction, SlackNotifier } from '@cloudcomponents/cdk-codepipeline-slack';
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 } from 'aws-cdk-lib/aws-codepipeline-actions';
import { Construct } from 'constructs';
export class CodePipelineSlackApprovalStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
const repository = new Repository(this, 'Repository', {
repositoryName: 'MyRepositoryName',
});
const sourceArtifact = new Artifact();
const sourceAction = new CodeCommitSourceAction({
actionName: 'CodeCommit',
repository,
output: sourceArtifact,
});
if (typeof process.env.SLACK_BOT_TOKEN === 'undefined') {
throw new Error('environment variable SLACK_BOT_TOKEN undefined');
}
const slackBotToken = process.env.SLACK_BOT_TOKEN;
if (typeof process.env.SLACK_SIGNING_SECRET === 'undefined') {
throw new Error('environment variable SLACK_SIGNING_SECRET undefined');
}
const slackSigningSecret = process.env.SLACK_SIGNING_SECRET;
if (typeof process.env.SLACK_CHANNEL_NAME === 'undefined') {
throw new Error('environment variable SLACK_CHANNEL_NAME undefined');
}
const slackChannel = process.env.SLACK_CHANNEL_NAME;
const approvalAction = new SlackApprovalAction({
actionName: 'SlackApproval',
slackBotToken,
slackSigningSecret,
slackChannel,
externalEntityLink: 'http://cloudcomponents.org',
additionalInformation: 'Would you like to promote the build to production?',
});
const pipeline = new Pipeline(this, 'MyPipeline', {
pipelineName: 'MyPipeline',
stages: [
{
stageName: 'Source',
actions: [sourceAction],
},
{
stageName: 'Approval',
actions: [approvalAction],
},
],
});
new SlackNotifier(this, 'SlackNotifier', {
pipeline,
slackBotToken,
slackSigningSecret,
slackChannel,
});
}
}
Slack App Settings
Create an app that’s just for your workspace
OAuth & Permissions
Grant the channels::history
-Scope to the Bot in your app and Add the Bot to the configured Slack-Channel
Select Permission Scopes:
Interactive Components
Enter the url of your api from the AWS Api Gateway and append /slack/actions
:
API Reference
See API.md.
Example
See more complete examples.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for cloudcomponents.cdk-codepipeline-slack-2.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9216648de4867deb0d83daf978e161c7d7a9e006c8caf3424caf78979f51923 |
|
MD5 | f54040a25f8e578687bd5ee3d969b118 |
|
BLAKE2b-256 | eea1666366ffeab1d13c5f958df8002fee563bc11f867d1c17159cbb66a60fa0 |
Close
Hashes for cloudcomponents.cdk_codepipeline_slack-2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88e901407aadbf581649fd2ff2c3b25b3d97c5c369daa1be767c9e3038f9eab2 |
|
MD5 | 67618f7a78332a092cb28a91a744b037 |
|
BLAKE2b-256 | fbf31693734a144efb935ee9495c67b686d7c05ecd0e6e8da8e4b31d9ffa47a3 |