{"id":26403556,"url":"https://github.com/fossamagna/amplify-slack-bot","last_synced_at":"2025-03-17T15:34:25.684Z","repository":{"id":145772540,"uuid":"578892357","full_name":"fossamagna/amplify-slack-bot","owner":"fossamagna","description":"Slack App to notification build result from AWS Amplify Console 🚀","archived":false,"fork":false,"pushed_at":"2023-12-15T05:45:18.000Z","size":22,"stargazers_count":6,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"dev","last_synced_at":"2025-01-04T14:52:50.999Z","etag":null,"topics":["amplify","amplify-console","slack"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fossamagna.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-12-16T06:06:50.000Z","updated_at":"2023-11-22T16:47:31.000Z","dependencies_parsed_at":"2023-12-15T06:50:23.936Z","dependency_job_id":null,"html_url":"https://github.com/fossamagna/amplify-slack-bot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fossamagna%2Famplify-slack-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fossamagna%2Famplify-slack-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fossamagna%2Famplify-slack-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fossamagna%2Famplify-slack-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fossamagna","download_url":"https://codeload.github.com/fossamagna/amplify-slack-bot/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244058737,"owners_count":20391160,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amplify","amplify-console","slack"],"created_at":"2025-03-17T15:34:23.909Z","updated_at":"2025-03-17T15:34:25.678Z","avatar_url":"https://github.com/fossamagna.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# amplify-slack-bot\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails open=\"open\"\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#related-article-and-project\"\u003eRelated article and project\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\nThis project is Slack App with AWS Amplify to notifications the build result from AWS Amplify Console.\n\nYou can add email notifications to notify stakeholders when a build succeeds or fails. But, cannot notify to Chat service (e.g. Slack).\nIf you use this app, You can take notification from Amplify Console with Slack.\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\n### Click `DEPLOY TO AMPLIFY CONSOLE` button\n\n[![amplifybutton](https://oneclick.amplifyapp.com/button.svg)](https://console.aws.amazon.com/amplify/home#/deploy?repo=https://github.com/fossamagna/amplify-slack-bot)\n\n### service role\n\nThe `amplify-slack-bot` requires the addition of the following permissions to the service role.\n```json\n{\n    \"Version\": \"2012-10-17\",\n    \"Statement\": [\n        {\n            \"Sid\": \"\",\n            \"Effect\": \"Allow\",\n            \"Action\": [\n                \"lambda:CreateFunctionUrlConfig\",\n                \"lambda:GetFunctionUrlConfig\",\n                \"lambda:DeleteFunctionUrlConfig\",\n                \"lambda:UpdateFunctionUrlConfig\",\n                \"sns:GetTopicAttributes\",\n                \"sns:SetTopicAttributes\",\n                \"sns:DeleteTopic\",\n                \"sns:CreateTopic\",\n                \"sns:Subscribe\"\n            ],\n            \"Resource\": [\n                \"arn:aws:lambda:*:\u003caccountId\u003e:function:*\",\n                \"arn:aws:sns:*:\u003caccountId\u003e:*\"\n            ]\n        }\n    ]\n}\n```\n\n### Create new Slack app\n\nSince `amplify-slack-bot` works as a Slack app, you must visit [your apps](https://api.slack.com/apps) on the Slack API website, and click Create New App.\nPlease follow [here](https://github.com/fossamagna/amplify-category-console-notification/blob/main/packages/amplify-slack-app/docs/SETUP.md) to set up the Slack app. \n\n### Register Secret Parameters\n\nOnce the Slack app is created, register the three secrets in the AWS parameter store.\n\n- SLACK_SIGNING_SECRET\n- SLACK_BOT_TOKEN\n- SLACK_DEFAULT_CHANNEL\n\nA repository has been created in your GitHub account where you forked amplify-slack-bot. Clone the repository. Pull the deployed app by running the `amplify pull` command.\n\n![register-secret-parameters](https://user-images.githubusercontent.com/1638848/208944628-d6f23d0e-197a-4684-94b0-9ac457a5086b.gif)\n\n### Edit `amplify/backend/function/slackApp/parameters.json`\n\nSet the ID of the deployed app to `secretsPathAmplifyAppId` in `amplify/backend/function/slackApp/parameters.json`.\n\n```json\n{\n  \"secretsPathAmplifyAppId\": \"\u003cappId\u003e\"\n}\n```\n\nYou can get the ID of the app by executing the following command. Replace the `\u003cappId\u003e` with its value. After rewriting the file, git commit it.\n\n```\namplify env get --name dev | grep AmplifyAppId\n```\n\nAfter git push, Amplify Console will automatically start building and you will receive Amplify Console build notifications on the Slack channel you have set up.\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\nSee the [open issues](https://github.com/fossamagna/amplify-slack-bot/issues) for a list of proposed features (and known issues).\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the Apache-2.0 License. See `LICENSE` for more information.\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nMasahiko MURAKAMI - [@fossamagna](https://twitter.com/fossamagna)\n\nProject Link: [https://github.com/fossamagna/amplify-slack-bot](https://github.com/fossamagna/amplify-slack-bot)\n\n\u003c!-- RELATED ARTICLE AND PROJECT --\u003e\n## Related article and project\n\n- [Deploy to Amplify Consoleボタンを試してみた (Japanese)](https://fossamagna.github.io/deploy-to-amplify-console/)\n- [amplify-category-console-notification](https://github.com/fossamagna/amplify-category-console-notification)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffossamagna%2Famplify-slack-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffossamagna%2Famplify-slack-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffossamagna%2Famplify-slack-bot/lists"}