{"id":20742687,"url":"https://github.com/itinerisltd/trellis-slack-webhook-notify-during-deploy","last_synced_at":"2025-04-24T05:16:02.369Z","repository":{"id":56602479,"uuid":"168048889","full_name":"ItinerisLtd/trellis-slack-webhook-notify-during-deploy","owner":"ItinerisLtd","description":"Sends a deployment complete message to a Slack channel when Trellis deploys Bedrock.","archived":false,"fork":false,"pushed_at":"2022-08-24T21:53:56.000Z","size":46,"stargazers_count":16,"open_issues_count":5,"forks_count":5,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-24T05:15:46.775Z","etag":null,"topics":["slack","trellis","wordpress-development"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ItinerisLtd.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-28T22:32:15.000Z","updated_at":"2024-06-27T11:30:58.000Z","dependencies_parsed_at":"2022-08-15T21:40:51.238Z","dependency_job_id":null,"html_url":"https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ItinerisLtd%2Ftrellis-slack-webhook-notify-during-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ItinerisLtd%2Ftrellis-slack-webhook-notify-during-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ItinerisLtd%2Ftrellis-slack-webhook-notify-during-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ItinerisLtd%2Ftrellis-slack-webhook-notify-during-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ItinerisLtd","download_url":"https://codeload.github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250566511,"owners_count":21451234,"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":["slack","trellis","wordpress-development"],"created_at":"2024-11-17T07:07:03.530Z","updated_at":"2025-04-24T05:16:02.351Z","avatar_url":"https://github.com/ItinerisLtd.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# trellis-slack-webhook-notify-during-deploy\n\n[![GitHub tag](https://img.shields.io/github/tag/ItinerisLtd/trellis-slack-webhook-notify-during-deploy.svg)](https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy/tags)\n[![license](https://img.shields.io/github/license/ItinerisLtd/trellis-slack-webhook-notify-during-deploy.svg)](https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy/blob/master/LICENSE)\n\n\nSends a deployment complete message to a Slack channel when [Trellis](https://github.com/roots/trellis) deploys [Bedrock](https://github.com/roots/bedrock).\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n\n- [Requirements](#requirements)\n- [Screenshots](#screenshots)\n- [Installation](#installation)\n- [Role Variables](#role-variables)\n- [Usage](#usage)\n- [FAQs](#faqs)\n  - [How do I get a Slack Webhook URL?](#how-do-i-get-a-slack-webhook-url)\n- [See Also](#see-also)\n- [Testing](#testing)\n  - [Syntax Check](#syntax-check)\n- [Author Information](#author-information)\n- [Feedback](#feedback)\n- [Change log](#change-log)\n- [License](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Requirements\n\n- Trellis v1.0.0 or later\n- Ansible v2.6 or later\n- Valid Slack Webhook URL\n\n## Screenshots\n![Deployment Screenshot](deployment-screenshot.png)\n\n## Installation\n\nAdd this role to `galaxy.yml`:\n```yaml\n# galaxy.yml\n- src: https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy\n  version: 0.1.0 # Check for latest version!\n```\n\nRun the command:\n```bash\n➜ ansible-galaxy install -r galaxy.yml --force\n```\n\n## Role Variables\n\nAdd this role to the [`deploy_after` hook](https://roots.io/trellis/docs/deploys/#hooks):\n```yaml\n# group_vars/all/deploy-hooks.yml\n# Learn more on https://roots.io/trellis/docs/deploys/#hooks\ndeploy_after:\n  - \"{{ playbook_dir }}/vendor/roles/trellis-slack-webhook-notify-during-deploy/tasks/main.yml\"\n```\n\nAdd your Webhook token (end of the Webhook URL) and channel into `group_vars/all/main.yml`\n\n```yaml\nslack_webhook_token: XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXX\nslack_webhook_channel: '#development-alerts'\n```\n\n## Usage\n\n[Deploy](https://roots.io/trellis/docs/deploys/#example) as usual. No special action needed.\n\n## FAQs\n\n### How do I get a Slack Webhook URL?\n\n1. Visit the [\"Your Apps\"](https://api.slack.com/apps) page on Slack\n2. Create an App (e.g. \"Deployment alerts\") and enable \"Incoming Webhooks\"\n3. Setup a Webhook for your desired Workspace\n4. Copy the Webhook URL for use in [Installation](#installation)\n\n## See Also\n\n- [Incoming WebHooks for Slack](https://get.slack.help/hc/en-us/articles/115005265063-Incoming-webhooks-for-Slack)\n\n## Testing\n\n### Syntax Check\n\n```bash\n➜ ansible-playbook -i 'localhost,' --syntax-check tests/test.yml\n```\n\n## Author Information\n\n[trellis-slack-webhook-notify-during-deploy](https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy) is a [Itineris Limited](https://www.itineris.co.uk/) project created by [Lee Hanbury-Pickett](https://github.com/codepuncher).\n\nSpecial thanks to [the Roots team](https://roots.io/about/) whose [Trellis](https://github.com/roots/trellis) make this project possible.\n\nFull list of contributors can be found [here](https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy/graphs/contributors).\n\n## Feedback\n\n**Please provide feedback!** We want to make this library useful in as many projects as possible.\nPlease submit an [issue](https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy/issues/new) and point out what you do and don't like, or fork the project and make suggestions.\n**No issue is too small.**\n\n## Change log\n\nPlease see [CHANGELOG](./CHANGELOG.md) for more information on what has changed recently.\n\n## License\n\n[trellis-slack-webhook-notify-during-deploy](https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy) is released under the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitinerisltd%2Ftrellis-slack-webhook-notify-during-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitinerisltd%2Ftrellis-slack-webhook-notify-during-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitinerisltd%2Ftrellis-slack-webhook-notify-during-deploy/lists"}