amplify-category-console-notification
amplify-category-console-notification copied to clipboard
fossamagna
Amplify plugin to add notifications to Slack for ther build result from AWS Amplify Console :rocket:
Table of Contents
- About The Project
-
Getting Started
- Prerequisites
- Installation
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgements
About The Project
This project is amplify plugin to add notifications to Slack for ther build result from AWS Amplify Console.
You can add email notifications to notify stakeholders when a build succeeds or fails. But, cannot notify to Chat service (e.g. Slack). If you use this plugin, You can add feature to notify Slack to your amplify project backend.
Getting Started
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
Prerequisites
First, install AWS Amplify CLI using npm (we assume you have pre-installed node.js).
npm install -g @aws-amplify/cli
Second, create Slack Incoming Webhook. See here for more information. Later, input your Incoming Webhook URL when prompt to input webhook from amplify cli.
Installation
- Install NPM packages
npm install -g amplify-category-console-notification amplify-slack-nodejs-function-template-provider - Enable this plugin
amplify plugin add $(npm root -g)/amplify-category-console-notification amplify plugin add $(npm root -g)/amplify-slack-nodejs-function-template-provider
Usage
$ amplify console-notification add
Using service: AmplifyConsoleNotification, provided by: awscloudformation
? Provide an AWS Lambda function name: SendToSlack
? Input Web hook URL of Slack. https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
Commands Summary
The following table lists the current set of commands supported by the Amplify Console Notification Category Plugin.
| Command | Description |
|---|---|
| amplify console-notification add | Takes you through steps in the CLI to add some resources for notifications to your backend. |
| amplify console-notification remove | Removes resources for notifications from your local backend. The resources are removed from the cloud on the next push command. |
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the Apache-2.0 License. See LICENSE for more information.
Contact
Masahiko MURAKAMI - @fossamagna
Project Link: https://github.com/fossamagna/amplify-category-console-notification
Acknowledgements
- Amplify Console のビルド通知をSlackで受け取るためにやったこと (Japanese)
Metadata
Owner
fossamagna
Metadata
Amplify plugin to add notifications to Slack for ther build result from AWS Amplify Console :rocket: