cdk-codepipeline-badge-notification
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.57 • Public • Published

    NPM version PyPI version Release

    CDK-CodePipeline-Badge-Notification

    Feature

    • Generate badge when AWS CodePipeline state change

    • Update GitHub commit status when AWS CodePipeline state change

    • Notification for chat bot provider

      • Slack
      • Google
      • Telegram

    Usage

    import { CodePipelineBadgeNotification } from 'cdk-pipeline-badge-notification';
    import * as cdk from '@aws-cdk/core';
    import * as codePipeline from '@aws-cdk/aws-codepipeline';
    
    const app = new cdk.App();
    const env = {
      region: process.env.CDK_DEFAULT_REGION,
      account: process.env.CDK_DEFAULT_ACCOUNT,
    };
    const stack = new cdk.Stack(app, 'codepipeline-badge-notification', { env });
    
    const pipeline = new codePipeline.Pipeline(stack, 'TestPipeline', {
      pipelineName: 'testCodePipeline',
      crossAccountKeys: false,
    });
    
    new CodePipelineBadgeNotification(stack, 'CodePipelineBadgeNotification', {
      pipelineArn: pipeline.pipelineArn,
      gitHubTokenFromSecretsManager: {
        secretsManagerArn:
          'arn:aws:secretsmanager:ap-northeast-1:111111111111:secret:codepipeline/lambda/github-token-YWWmII',
        secretKey: 'codepipeline/lambda/github-token',
      },
      notification: {
        stageName: 'production',
        ssmSlackWebHookUrl: '/chat/google/slack',
        ssmGoogleChatWebHookUrl: '/chat/google/webhook',
        ssmTelegramWebHookUrl: '/chat/telegram/webhook',
      },
    });

    ⚠️ telegram webhook url from ssm parameter which the URL is not include text query string

    gitHubTokenFromSecretsManager and notification is optional

    Only badge

    new CodePipelineBadgeNotification(stack, 'CodePipelineBadgeNotification', {
      pipelineArn: pipeline.pipelineArn,
    });

    Install

    npm i cdk-codepipeline-badge-notification

    DownloadsWeekly Downloads

    1,177

    Version

    0.2.57

    License

    Apache-2.0

    Unpacked Size

    195 kB

    Total Files

    23

    Last publish

    Collaborators

    • 9incloud