Slack integration for deployments via Capistrano

Posted About 9 years ago. Visible to the public. Linked content.

You can hook into Slack Show archive.org snapshot when using Capistrano for deployment. The slackistrano Show archive.org snapshot gem does most of the heavy lifting for you. Its default messages are unobtrusive and can be adjusted easily.

When deploying, it posts to a Slack channel like this:

Example

How to integrate

Integrating Slackistrano with Capistrano 3 is fairly simple.

  1. In your Slack, open menu → Administration → Manage apps, and add an "Incoming WebHooks" Show archive.org snapshot integration.

  2. Choose channel, and add the app.

  3. Set a name and save. This will not be used for notifications, but clarifies the webhook's purpose when browsing the list of integrations.

  4. Copy your "Webhook URL".

  5. Add slackistrano to your Gemfile, in your :deploy group, and bundle your project.

  6. Add the following to your Capfile.

    # Slack notifications
require 'slackistrano/capistrano'
set :slackistrano, {
  channel: '#your-channel',
  webhook: 'https://hooks.slack.com/services/your/webhook/url',
}

  7. Optional: Tweak your deployment messages Show archive.org snapshot . See the attached file for our default message formatting. Your Capfile needs to be adjusted accordingly:

    # Slack notifications
require 'slackistrano/capistrano'
require_relative 'lib/capistrano/slackistrano'
set :slackistrano, {
  klass: Slackistrano::CustomMessaging,
  channel: '#your-channel',
  webhook: 'https://hooks.slack.com/services/your/webhook/url',
}

  8. Test Slackistrano:

    cap staging slack:deploy:test

  9. When you are satisfied, do a real deploy to confirm everything works.

slackistrano.pngslackistrano.rbgithub.com
Arne Hartherz
makandra.com
Say thanks6
Last edit
Over 2 years ago
Deleted user #8242
Attachments
slackistrano.png
slackistrano.rb
License
Source code in this card is licensed under the MIT License.

Related cards:

Remove resource fork files from a FAT volume on MacOS

Be careful!
The following solution will delete files on a volume. If you don't know exactly what you're doing, you can run into big trouble with your computer.

I play mp3 files on my car stereo that are stored on a SD-C...

Rails: Assigning associations via HTML forms

Let's say we have posts with an attribute title that is mandatory.

Our example feature request is to tag these posts with a limited number of tags. The following chapters explain different approaches in Rails, how you can assign such a...

Make Capistrano use SSH Key Forwarding

When deploying code with Capistrano (depending on your configuration) at some point Capistrano tries to check out code from your repository. In order to do so, Capistrano connects to your repository server from the application server you're deploy...

Read your mail in networks that forbid e-mail traffic

If you are connected with a network that forbids e-mail traffic but allows SSH, you can tunnel your e-mail connection through a trusted, intermediary server:

 sudo ssh -i /home/local-user/.ssh/local-user.key -L 143:mail-server.tld:143 remote-...

Good real world example for form models / presenters in Rails

We have often felt the pain where our models need to serve too many masters. E.g. we are adding a lot of logic and callbacks for a particular form screen, but then the model becomes a pain in tests, where all those callbacks just get in the way. O...

How to build the perfect number of blank records for a nested form

When you render a nested form for a Movie which has_many :actors, you want to render the right number of blank Actor forms. The right number means:

  • A minimum number of blank forms so the user can add more Actors to an existing Movie, ...

How to not die with ActionView::MissingTemplate when clients request weird formats

When HTTP clients make an request they can define which response formats they can process. They do it by adding a header to the HTTP request like this:

Accept: application/json

This means the client will only understand JSON respon...

Always show all form errors during development

You've been there: A form cannot be submitted, but you don't see a validation error because the field at fault has no corresponding input field on the form. Because this is usually a bug, you insert debug information listing all errors into the fo...

Use <input type="number"> for numeric form fields

Any form fields where users enter numbers should be an <input type="number">.

Numeric inputs have several benefits over <input type="text">:

  • On mobile or tablet devices, number fields show a special virtual keyboard that shows mostly digit...

Use form_for without the enclosing form tag

In rare cases you might need something like form_for (for using form builder methods on the resulting block element) but without the surrounding form. One such case would be upda...

Posted by Arne Hartherz to makandra dev (2015-03-19 17:33)
This website uses short-lived cookies to improve usability.
or learn more