Merge pull request #2 from mike-sheppard/master

Add git username, git commit link & simplify message

Author: faahim

README.md

@@ -1,10 +1,10 @@
-# trellis-slack-webhook-notify-during-deploy
+# Trellis Slack Webhook Depolyment Notifications
 
 [![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)
 [![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)
 
 
-Sends a deployment complete message to a Slack channel when [Trellis](https://github.com/roots/trellis) deploys [Bedrock](https://github.com/roots/bedrock).
+Sends an initial deployment started and a deployment successful message to a Slack channel when [Trellis](https://github.com/roots/trellis) deploys [Bedrock](https://github.com/roots/bedrock).
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -38,33 +38,47 @@ Sends a deployment complete message to a Slack channel when [Trellis](https://gi
 
 ## Installation
 
-Add this role to `requirements.yml`:
+Add this role to `requirements.yml` or `galaxy.yml` in newer versions of Trellis:
 ```yaml
-# requirements.yml
-- src: https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy
-  version: 0.1.0 # Check for latest version!
+# requirements.yml / galaxy.yml
+- name: slack-notify
+  src: https://github.com/ItinerisLtd/trellis-slack-webhook-notify-during-deploy
+  version: 0.3.0 # Check for latest version!
 ```
 
 Run the command:
 ```bash
 ➜ ansible-galaxy install -r requirements.yml --force
 ```
 
+With newer versions of Trellis, run:
+```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):
+Add these roles`deploy_before` & `deploy_finalize_after` to the deploy [hooks](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"
+# roles/deploy/defaults/main.yml
+deploy_before:
+  - "{{ playbook_dir }}/vendor/roles/slack-notify/tasks/deploy_start.yml"
+
+...
+
+deploy_finalize_after:
+  - "{{ playbook_dir }}/roles/deploy/hooks/finalize-after.yml"
+  - "{{ playbook_dir }}/vendor/roles/slack-notify/tasks/deploy_success.yml"
 ```
 
-Add your Webhook token (end of the Webhook URL) and channel into `group_vars/all/main.yml`
+Add your Webhook token (end of the Webhook URL), channel and projects github repo into `group_vars/all/main.yml`
 
 ```yaml
+# group_vars/all/main.yml
 slack_webhook_token: XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXX
 slack_webhook_channel: '#development-alerts'
+slack_git_repo_url: "https://github.com/username/repo-name"
 ```
 
 ## Usage

deployment-screenshot.png

@@ -0,0 +1,10 @@
+---
+- name: Send initial deployment notification to Slack
+  slack:
+    token: "{{ slack_webhook_token }}"
+    channel: slack_webhook_channel
+    attachments:
+      - text: "*{{ lookup('pipe', 'git config user.name') }}* has started deploying {{ site }} to *<https://{{ project.site_hosts | map(attribute='canonical') | first }}|{{ env }}>*"
+        color: warning
+  when: slack_webhook_token is defined and slack_webhook_token != ""
+  delegate_to: localhost

tasks/deploy_start.yml

@@ -0,0 +1,10 @@
+---
+- name: Send successful deployment notification to Slack
+  slack:
+    token: "{{ slack_webhook_token }}"
+    channel: slack_webhook_channel
+    attachments:
+      - text: "*{{ lookup('pipe', 'git config user.name') }}* successfully deployed {{ site }} to *<https://{{ project.site_hosts | map(attribute='canonical') | first }}|{{ env }}>* [<{{ slack_git_repo_url }}/commit/{{ git_clone.after }}|deployed commit>]"
+        color: good
+  when: slack_webhook_token is defined and slack_webhook_token != ""
+  delegate_to: localhost