@schibsted/serverless-slack-deploy-notification

Serverless Slack deploy notification

A Serverless plugin that sends a slack message on deployment start and finish

Demo

When deployment starts plugin posts a message like this:

When deployment finishes successfully plugin updates the first message into:

Sadly there's no way to detect a deployment error and send a notification then. In that case you get stuck on the 'deployment in progress' notification

Additionally, when the deploy finishes, plugin posts app details into a thread of the notification e.g.

Installation

npm install @schibsted/serverless-slack-deploy-notification --save-dev

Options

Required

• token - Slack API token with at least chat.write scope
• channel - Channel ID (not channel name)

Optional

• enabled - Turn notifications off for specific stages
• logo - make the notification easier to notice by putting app logo on the side of the message
• travisUrl - URL to your builds in Travis
• githubUrl - URL to your Github repository
• appUrl - URL where the application you're deploying will be accessible

See the sample usage below.

Usage

service: your-service
provider:
  name: aws
  runtime: nodejs12.x

custom:
  slackDeployNotification:
    enabled:
      staging: false
    token: %SLACK_WEB_API_TOKEN
    channel: %SLACK_CHANNEL_ID
    logo: https://cdn.pixabay.com/photo/2015/12/11/11/43/google-1088004_1280.png
    travisUrl: https://travis.schibsted.io/foo/bar
    githubUrl: https://github.schibsted.io/foo/bar
    appUrl: https://google.com

plugins:
  - "@schibsted/serverless-slack-deploy-notification"

functions:
  foo:
    handler: foo.handler

Contributing

Everyone is very welcome to contribute to this repository. Feel free to raise issues or to submit Pull Requests.

Changelog

0.4.1 (2022-08-29)

Miscellaneous Chores

• deps: bump parse-url from 6.0.0 to 6.0.2 (#114) (a1af6aa)
• deps: update babel monorepo to v7.18.2 (#100) (da0db00)
• deps: update babel monorepo to v7.18.9 (#117) (ba9f4b8)
• deps: update commitlint monorepo to v16.2.4 (#86) (b4c6f65)
• deps: update dependency @babel/core to v7.17.10 (#87) (d4464cd)
• deps: update dependency @babel/core to v7.17.12 (#95) (5913327)
• deps: update dependency @babel/core to v7.17.8 (#67) (bedb420)
• deps: update dependency @babel/core to v7.17.9 (#77) (f2652e0)
• deps: update dependency @babel/core to v7.18.0 (#97) (2b3f5e5)
• deps: update dependency @babel/core to v7.18.10 (#118) (d14bf1a)
• deps: update dependency @babel/core to v7.18.13 (#119) (408f155)
• deps: update dependency @babel/core to v7.18.5 (#105) (057d976)
• deps: update dependency @babel/core to v7.18.6 (#110) (4ec1813)
• deps: update dependency @commitlint/cli to v16.3.0 (#93) (df3bbc3)
• deps: update dependency @commitlint/cli to v17.1.2 (#122) (0eb93ab)
• deps: update dependency @release-it/conventional-changelog to v4.3.0 (#81) (f00a63b)
• deps: update dependency eslint to v8.12.0 (#72) (9400a61)
• deps: update dependency eslint to v8.13.0 (#78) (8d125f4)
• deps: update dependency eslint to v8.14.0 (#84) (a4acd5b)
• deps: update dependency eslint to v8.15.0 (#91) (a3e166a)
• deps: update dependency eslint to v8.16.0 (#98) (2316e95)
• deps: update dependency eslint to v8.17.0 (#104) (3d89693)
• deps: update dependency eslint to v8.18.0 (#108) (a0fcca4)
• deps: update dependency eslint to v8.23.0 (#113) (327a0e8)
• deps: update dependency eslint-plugin-import to v2.26.0 (#76) (5c0dad5)
• deps: update dependency eslint-plugin-prettier to v4.1.0 (#109) (4b9052d)
• deps: update dependency eslint-plugin-prettier to v4.2.1 (#112) (d17d5fe)
• deps: update dependency husky to v8 (#92) (00e1bf3)
• deps: update dependency lint-staged to v12.3.8 (#82) (491ec86)
• deps: update dependency lint-staged to v12.4.0 (#83) (0fee3bf)
• deps: update dependency lint-staged to v12.4.1 (#85) (da739ed)
• deps: update dependency lint-staged to v12.4.2 (#99) (06febda)
• deps: update dependency lint-staged to v12.4.3 (#101) (78c7957)
• deps: update dependency lint-staged to v12.5.0 (#102) (4c77599)
• deps: update dependency lint-staged to v13 (#103) (0ac926e)
• deps: update dependency minimist to 1.2.6 [security] (#71) (0e33f42)
• deps: update dependency prettier to v2.6.1 (#70) (c306764)
• deps: update dependency prettier to v2.6.2 (#75) (043bbad)
• deps: update dependency prettier to v2.7.0 (#106) (b6750e6)
• deps: update dependency prettier to v2.7.1 (#107) (f88907d)
• deps: update dependency release-it to v14.13.0 (#68) (565e8a5)
• deps: update dependency release-it to v14.13.1 (#69) (1449694)
• deps: update dependency release-it to v14.14.0 (#74) (6d277a5)
• deps: update dependency release-it to v14.14.1 (#79) (9670ea6)
• deps: update dependency release-it to v14.14.2 (#80) (5aeb0f2)
• deps: update dependency release-it to v14.14.3 (#88) (e14ec3b)
• deps: update release-related tools (#96) (bb65f4b)