capistrano-slacky 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d8a000422ee77540816f23c92063aaafbc39d62c1d7328bca687abe74c42976
-  data.tar.gz: 96fea627fc2ef504cb8597a3c4c904ac75fda310b142f4e0e700e96659b9a6ea
+  metadata.gz: b4376f99f85cd346b93ac12f632e2e48b412fb63fa4e08df39b90caa1d2ad677
+  data.tar.gz: c3dba2f05bee71965340ecd4c916930220ace00bc68f223ed182367afc7a3d15
 SHA512:
-  metadata.gz: a2290b5b024df873244e1a0196befec28381519aa5ad8ccdecf5c2d67931e0653cc68fc8c4325809381a038d8fe890ccff88dcfdb6969994337ffc61ad52d7d4
-  data.tar.gz: bbca074fb05c97288aecbdf858cfcdb03dabbcd2cc969c183e42d39f17e9f32171cb29f5fe762e6df3301dbaf3fb71d88e703312d37adedc2f4a7b64a9984689
+  metadata.gz: bc260001544951a188d32e91542f63c59508d3abefd8e8656b8b8b14b95ae37efa7e2bd40e3c1a4b0f533d3722b68287fa9ae9112a14311babdac00d1ca50a2c
+  data.tar.gz: e1885a2c60f1fc88f98a1dcefd06bdd689477484963a2cf50229b41d574d170830dbf326eaa5ea3ab49ff435897b68e8af883a4d58ecf5f11574550de1053eea

data/CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [0.1.3] - 2021-06-14
+### Changed
+- Update `README.md`. ([@chubchenko][])
+
+### Fixed
+- Change commit message encoding to `UTF-8`. ([@chubchenko][])
+
 ## [0.1.2] - 2021-06-03
 ### Changed
 - Use `I18n.t` instead of `t`. ([@chubchenko][])
@@ -31,7 +40,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial version. ([@chubchenko][])
 
 [@chubchenko]: https://github.com/chubchenko
-[Unreleased]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.1...HEAD
+[Unreleased]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.3...HEAD
+[0.1.3]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/chubchenko/capistrano-slacky/releases/tag/v0.1.0

data/README.md

@@ -1,14 +1,123 @@
+<div align="center">
+  <img align="center"
+       height="100"
+       title="capistrano-slacky logo"
+       src="./assets/images/logo.svg">
+</div>
+
+[![gem version][9]][10]
 [![build][1]][2]
+[![downloads][11]][12]
 
 # capistrano-slacky
 
-Send `Capistrano` deployment status to `Slack`.
+Send `Capistrano` deployment status to `Slack` via the Incoming Webhooks integration.
+
+- Messages are built on the basis of the [Block Kit][13]. See [Demo](#demo) section.
+- Fires after every successful/failed deployment or rollback.
+- Use _Incoming Webhook URL_ from the remote server.
+- Send commit log between 2 deployments.
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Usage](#usage)
+- [Demo](#demo)
+
+## Requirements
+
+- Ruby >= 2.5
+- Capistrano ~> 3.0
+- Slack
+
+## Installation
+
+Add the following line to your `Gemfile`:
+
+```ruby
+gem "capistrano-slacky", "~> 0.1", require: false
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Configuration
+
+Out of the box, the gem has a default configuration:
+
+```ruby
+set :slacky, username: "ChatOps", # Set your bot's user name.
+             icon_emoji: ":robot_face:", # Emoji to use as the icon for this message.
+             channel: "#deployment", # The name of the channel to send a message to.
+             klass: Capistrano::Slacky::Messaging::Default # The class that responsible for creating a message.
+```
+
+So you can easily tweak your deployment messages and all other configuration to what you want.
+
+## Usage
+
+Require the library in your application's Capfile
+
+```ruby
+require "capistrano/slacky"
+```
+
+- Add an [Incoming Webhooks][4] to your Slack.
+- The received _Incoming Webhook URL_ must be uploaded to the remote server. It should be stored in a `shared` directory under the following path `config/slacky.yml`.
+- Run `cap production slacky:ping` command to test your integration.
+
+That's all, deploy your application as usual and you will see a deployment notification in your Slack channel.
+
+In case if you want to disable deployment notifications for a specific stage just set `slacky` to `false`.
+
+```ruby
+set :slacky, false
+```
+
+## Demo
+
+![Deployed successfully][5]
+
+![Reverted successfully][6]
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against][2] the following Ruby implementations:
+
+- Ruby 2.5
+- Ruby 2.6
+- Ruby 2.7
+- Ruby 3.0
+
+If something doesn't work on one of these Ruby versions, it's a bug.
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][4]. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, that version should be immediately yanked, and/or a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions. As a result of this policy, you can (and should) specify a dependency on this gem using the [Pessimistic Version Constraint][5] with two digits of precision. For example:
+
+```ruby
+gem "capistrano-slacky", "~> 0.1"
+```
 
 ## License
 
 [MIT][3]
 
-
 [1]: https://github.com/chubchenko/capistrano-slacky/actions/workflows/build.yml/badge.svg
 [2]: https://github.com/chubchenko/capistrano-slacky/actions/workflows/build.yml
 [3]: https://choosealicense.com/licenses/mit
+[4]: https://api.slack.com/messaging/webhooks
+[5]: ./assets/images/deployed_successfully.jpg
+[6]: ./assets/images/deployment_failed.jpg
+[7]: ./assets/images/reverted_successfully.jpg
+[8]: ./assets/images/rollback_failed.jpg
+[9]: https://badge.fury.io/rb/capistrano-slacky.svg
+[10]: https://badge.fury.io/rb/capistrano-slacky
+[11]: https://img.shields.io/gem/dt/capistrano-slacky
+[12]: https://rubygems.org/gems/capistrano-slacky
+[13]: https://api.slack.com/block-kit

data/lib/capistrano/slacky/command/diff.rb

@@ -54,6 +54,9 @@ module Capistrano
           "0" => ":zero:"
         }.freeze
 
+        DEFAULT_ENCODING = "UTF-8"
+        private_constant :DEFAULT_ENCODING
+
         def initialize(index:, sha:, commit:)
           @index = index
           @sha = sha
@@ -71,7 +74,7 @@ module Capistrano
         end
 
         def commit
-          @commit.delete('"').strip
+          @commit.delete('"').strip.force_encoding(DEFAULT_ENCODING)
         end
 
         def to_a

data/lib/capistrano/slacky/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module Slacky
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-slacky
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Artem Chubchenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -72,7 +72,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
-description: Send Capistrano deployment status to Slack via the incoming webhooks
+description: Send Capistrano deployment status to Slack via the Incoming Webhooks
   integration
 email: artem.chubchenko@gmail.com
 executables: []