Skip to main content

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 Chat
    • Telegram

Support CDKv1 and CDKv2

CDKv2

npm install cdk-codepipeline-badge-notification
or
npm install cdk-codepipeline-badge-notification@latest
or
npm install cdk-codepipeline-badge-notification@^2.0.0

CDKv1

npm install cdk-codepipeline-badge-notification@cdkv1
or
npm install cdk-codepipeline-badge-notification@^1.0.6

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,
});

Metadata

Release files for cdk-codepipeline-badge-notification 2.0.78

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cdk-codepipeline-badge-notification 2.0.78
File Size Uploaded Provenance Actions
cdk-codepipeline-badge-notification-2.0.78.tar.gz 52.6 kB Without provenance Details for cdk-codepipeline-badge-notification-2.0.78.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cdk-codepipeline-badge-notification 2.0.78
File Interpreter ABI Platform Actions
cdk_codepipeline_badge_notification-2.0.78-py3-none-any.whl Python 3 none any Details for cdk_codepipeline_badge_notification-2.0.78-py3-none-any.whl

Total release size: 103.8 kB

Release files / cdk-codepipeline-badge-notification-2.0.78.tar.gz

Download URL cdk-codepipeline-badge-notification-2.0.78.tar.gz
Size 52.6 kB
Tags Source
SHA-256 checksum
How to use checksums
4027dd09350b39d84ae2499d7a072906ffebb0cee0ade0e1fe248519089a2c73
BLAKE2b-256 checksum
How to use checksums
9e3792dfa6ecc8fd12d8d2c5da39e320843c8d6ab72b2e76653d1aaf17a1a099
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

Release files / cdk_codepipeline_badge_notification-2.0.78-py3-none-any.whl

Download URL cdk_codepipeline_badge_notification-2.0.78-py3-none-any.whl
Size 51.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
807068d17ae37e0bcc4e892854d9ec00e8b5d1fb88eb5e88436210eb0519e7e6
BLAKE2b-256 checksum
How to use checksums
37209e58fffb0164b8e8013502cf2253750563eb2e50efe1fae65b703247d7d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

Security for cdk-codepipeline-badge-notification 2.0.78

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.0.78 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page