UnlyEd / slack-codebuild

Send AWS CodeBuild status messages to Slack Incoming WebHook.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Unly logo Maintainability Test Coverage Known Vulnerabilities

slack-codebuild

Send AWS CodeBuild status messages to Slack via an Incoming WebHook.

Getting Started

This utility is designed to be used in an AWS CodeBuild project.

Storing the SLACK_WEBHOOK_URL environment variable value in your AWS Systems Manager Parameter Store is strongly recommended.

Example buildspec.yml file:

env:
  parameter-store:
    SLACK_WEBHOOK_URL: /CodeBuild/MyProject/SlackWebHookUrl
    CODEBUILD_NOTIFY_ONLY_IF_FAIL: 1
    
phases:
  install:
    commands:
      - npm install -g slack-codebuild
  post_build:
    finally:
      - slack-codebuild

Environment Variables

SLACK_WEBHOOK_URL

The Incoming WebHook URL where messages will be posted (e.g. https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX)

AWS_REGION

The AWS region where the build is running.

This variable is automatically provided by CodeBuild.

CODEBUILD_BUILD_ID

The AWS CodeBuild ID of the build.

This variable is automatically provided by CodeBuild.

CODEBUILD_BUILD_SUCCEEDING

Whether the current build is succeeding. Set to 0 if the build is failing, or 1 if the build is succeeding.

CODEBUILD_NOTIFY_ONLY_IF_FAIL

Set to 0 if you want to be notify whatever, or 1 only on failure. Default set to 0

This variable is automatically provided by CodeBuild.

Vulnerability disclosure

See our policy.


Contributors and maintainers

This project is being maintained by:


[ABOUT UNLY] Unly logo

Unly is a socially responsible company, fighting inequality and facilitating access to higher education. Unly is committed to making education more inclusive, through responsible funding for students. We provide technological solutions to help students find the necessary funding for their studies.

We proudly participate in many TechForGood initiatives. To support and learn more about our actions to make education accessible, visit :

Tech tips and tricks from our CTO on our Medium page!

#TECHFORGOOD #EDUCATIONFORALL

About

Send AWS CodeBuild status messages to Slack Incoming WebHook.

License:MIT License


Languages

Language:JavaScript 100.0%