trellis-slack-webhook-notify-during-deploy

Sends a deployment complete message to a Slack channel when Trellis deploys Bedrock.

• Requirements
• Screenshots
• Installation
• Role Variables
• Usage
• FAQs
  • How do I get a Slack Webhook URL?
• See Also
• Testing
  • Syntax Check
• Author Information
• Feedback
• Change log
• 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:

# galaxy.yml
- src: https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy
  version: 0.1.0 # Check for latest version!

Run the command:

➜ ansible-galaxy install -r galaxy.yml --force

Role Variables

Add this role to the deploy_after hook:

# 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

slack_webhook_token: XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXX
slack_webhook_channel: '#development-alerts'

Usage

Deploy as usual. No special action needed.

FAQs

How do I get a Slack Webhook URL?

1. Visit the "Your 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

See Also

• Incoming WebHooks for Slack

Testing

Syntax Check

➜ ansible-playbook -i 'localhost,' --syntax-check tests/test.yml

Author Information

trellis-slack-webhook-notify-during-deploy is a Itineris Limited project created by Lee Hanbury-Pickett.

Special thanks to the Roots team whose Trellis make this project possible.

Full list of contributors can be found here.

Feedback

Please provide feedback! We want to make this library useful in as many projects as possible. Please submit an issue 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 for more information on what has changed recently.

License

trellis-slack-webhook-notify-during-deploy is released under the MIT License.