https://github.com/itinerisltd/trellis-slack-webhook-notify-during-deploy
Sends a deployment complete message to a Slack channel when Trellis deploys Bedrock.
https://github.com/itinerisltd/trellis-slack-webhook-notify-during-deploy
slack trellis wordpress-development
Last synced: about 1 year ago
JSON representation
Sends a deployment complete message to a Slack channel when Trellis deploys Bedrock.
- Host: GitHub
- URL: https://github.com/itinerisltd/trellis-slack-webhook-notify-during-deploy
- Owner: ItinerisLtd
- License: mit
- Created: 2019-01-28T22:32:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-08-24T21:53:56.000Z (almost 4 years ago)
- Last Synced: 2025-04-24T05:15:46.775Z (about 1 year ago)
- Topics: slack, trellis, wordpress-development
- Homepage:
- Size: 44.9 KB
- Stars: 16
- Watchers: 11
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# trellis-slack-webhook-notify-during-deploy
[](https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy/tags)
[](https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy/blob/master/LICENSE)
Sends a deployment complete message to a Slack channel when [Trellis](https://github.com/roots/trellis) deploys [Bedrock](https://github.com/roots/bedrock).
- [Requirements](#requirements)
- [Screenshots](#screenshots)
- [Installation](#installation)
- [Role Variables](#role-variables)
- [Usage](#usage)
- [FAQs](#faqs)
- [How do I get a Slack Webhook URL?](#how-do-i-get-a-slack-webhook-url)
- [See Also](#see-also)
- [Testing](#testing)
- [Syntax Check](#syntax-check)
- [Author Information](#author-information)
- [Feedback](#feedback)
- [Change log](#change-log)
- [License](#license)
## Requirements
- Trellis v1.0.0 or later
- Ansible v2.6 or later
- Valid Slack Webhook URL
## Screenshots
## Installation
Add this role to `galaxy.yml`:
```yaml
# galaxy.yml
- src: https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy
version: 0.1.0 # Check for latest version!
```
Run the command:
```bash
➜ ansible-galaxy install -r galaxy.yml --force
```
## Role Variables
Add this role to the [`deploy_after` hook](https://roots.io/trellis/docs/deploys/#hooks):
```yaml
# group_vars/all/deploy-hooks.yml
# Learn more on https://roots.io/trellis/docs/deploys/#hooks
deploy_after:
- "{{ playbook_dir }}/vendor/roles/trellis-slack-webhook-notify-during-deploy/tasks/main.yml"
```
Add your Webhook token (end of the Webhook URL) and channel into `group_vars/all/main.yml`
```yaml
slack_webhook_token: XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXX
slack_webhook_channel: '#development-alerts'
```
## Usage
[Deploy](https://roots.io/trellis/docs/deploys/#example) as usual. No special action needed.
## FAQs
### How do I get a Slack Webhook URL?
1. Visit the ["Your Apps"](https://api.slack.com/apps) page on Slack
2. Create an App (e.g. "Deployment alerts") and enable "Incoming Webhooks"
3. Setup a Webhook for your desired Workspace
4. Copy the Webhook URL for use in [Installation](#installation)
## See Also
- [Incoming WebHooks for Slack](https://get.slack.help/hc/en-us/articles/115005265063-Incoming-webhooks-for-Slack)
## Testing
### Syntax Check
```bash
➜ ansible-playbook -i 'localhost,' --syntax-check tests/test.yml
```
## Author Information
[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).
Special thanks to [the Roots team](https://roots.io/about/) whose [Trellis](https://github.com/roots/trellis) make this project possible.
Full list of contributors can be found [here](https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy/graphs/contributors).
## Feedback
**Please provide feedback!** We want to make this library useful in as many projects as possible.
Please 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.
**No issue is too small.**
## Change log
Please see [CHANGELOG](./CHANGELOG.md) for more information on what has changed recently.
## License
[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).