changelog-notifier 1.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 374a3a79445b96144828a772b1cf324709a2cc69299facf1d29c4b1811ab0a37
+  data.tar.gz: c419bfa4d08532dc332789372018c7f6d1ce70b92e7d07289f4a74907a595cc6
+SHA512:
+  metadata.gz: f3a42bfdea37eef6b474c803ad6761426171ee44d471d00af49943be9b104ccc4a6a3af762e0670acfab2614011915591c8d5696fc754c9d6d7d542d6365fd24
+  data.tar.gz: 2c40c703e172c8bb94667818924d434a4758be09d6117e7714856ef4df3ccefcb0732066565cf8bc74114b37abeeccb27e9b0db74c10be5e34e1e967f0abf4a4

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+spec/tmp
+
+*.gem

data/.gitlab-ci.yml

@@ -0,0 +1,30 @@
+# This file is a template, and might need editing before it works on your project.
+docker-build-master:
+  # Official docker image.
+  image: docker:latest
+  stage: build
+  services:
+    - docker:dind
+  before_script:
+    - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
+  script:
+    - docker build --pull -t "$CI_REGISTRY_IMAGE" .
+    - docker run --rm "$CI_REGISTRY_IMAGE"
+    - docker push "$CI_REGISTRY_IMAGE"
+  only:
+    - master
+
+docker-build:
+  # Official docker image.
+  image: docker:latest
+  stage: build
+  services:
+    - docker:dind
+  before_script:
+    - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
+  script:
+    - docker build --pull -t "$CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG" .
+    - docker run --rm "$CI_REGISTRY_IMAGE"
+    - docker push "$CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG"
+  except:
+    - master

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+require: rubocop-rspec
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: error

data/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+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]
+
+
+
+## [1.5.0] - 2020-10-18
+### Added
+- ActiveRecord adapter
+
+## [1.4.0] - 2020-10-13
+### Added
+- Screenshot in the `README.md` file
+
+### Removed
+- Remaning debugs
+
+## [1.3.0] - 2020-10-13
+### Fixed
+- Running commands remotely
+
+## [1.2.0] - 2020-10-13
+### Fixed
+- Using git on a Capistrano server
+
+## [1.1.0] - 2020-10-13
+### Added
+- Improves application name formatting in Slack adapter
+
+## [1.0.0] - 2020-10-12
+### Added
+- Capistrano entrypoint
+- CHANGELOG.md parser based on http://keepachangelog.com
+- Version fetching based on git tags
+- Version commit author fetching
+- Slack adapter to post the changelog to a Slack channel
+- Slack formatter
+
+[Unreleased]: https://gitlab.com/zedtux/changelog-notifier/-/compare/v1.5.0...master
+[1.5.0]: https://gitlab.com/zedtux/changelog-notifier/-/compare/v1.4.0...v1.5.0
+[1.4.0]: https://gitlab.com/zedtux/changelog-notifier/-/compare/v1.3.0...v1.4.0
+[1.3.0]: https://gitlab.com/zedtux/changelog-notifier/-/compare/v1.2.0...v1.3.0
+[1.2.0]: https://gitlab.com/zedtux/changelog-notifier/-/compare/v1.1.0...v1.2.0
+[1.1.0]: https://gitlab.com/zedtux/changelog-notifier/-/compare/v1.0.0...v1.1.0
+[1.0.0]: https://gitlab.com/zedtux/changelog-notifier/-/tags/v1.0.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at zedtux@zedroot.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,60 @@
+#
+# Builds a temporary image, with all the required dependencies used to compile
+# the dependencies' dependencies.
+# This image will be destroyed at the end of the build command.
+#
+FROM ruby:2.7-alpine3.12 AS build-env
+
+ARG GEM_ROOT=/gem
+ARG BUILD_PACKAGES="build-base git"
+ARG DEV_PACKAGES="sqlite-dev"
+ARG RUBY_PACKAGES="tzdata"
+
+RUN apk update && \
+    apk upgrade && \
+    apk add --update --no-cache $BUILD_PACKAGES \
+                                $DEV_PACKAGES \
+                                $RUBY_PACKAGES && \
+    mkdir -p /gem/
+
+WORKDIR $GEM_ROOT
+
+COPY Gemfile* *.gemspec /gem/
+COPY lib/changelog/notifier/version.rb /gem/lib/changelog/notifier/version.rb
+
+RUN touch ~/.gemrc && \
+    echo "gem: --no-ri --no-rdoc" >> ~/.gemrc && \
+    gem install rubygems-update && \
+    update_rubygems && \
+    gem install bundler && \
+    bundle install --jobs $(nproc) && \
+    rm -rf /usr/local/bundle/cache/*.gem && \
+    find /usr/local/bundle/gems/ -name "*.c" -delete && \
+    find /usr/local/bundle/gems/ -name "*.o" -delete
+
+COPY . /gem/
+
+#
+# Builds the final image with the minimum of system packages
+# and copy the gem's sources, Bundler gems and Yarn packages.
+#
+
+FROM ruby:2.7-alpine3.12
+
+LABEL maintainer="zedtux"
+
+ARG GEM_ROOT=/gem
+ARG PACKAGES="git sqlite sqlite-libs tzdata"
+
+RUN apk update && \
+    apk upgrade && \
+    apk add --update --no-cache $PACKAGES && \
+    mkdir -p /gem/
+
+WORKDIR $GEM_ROOT
+
+COPY --from=build-env /usr/local/bundle/ /usr/local/bundle/
+COPY --from=build-env $GEM_ROOT $GEM_ROOT
+
+ENTRYPOINT ["bundle", "exec"]
+CMD ["rake"]

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in changelog-notifier.gemspec
+gemspec
+
+gem 'activerecord', '~> 6.0'
+gem 'database_cleaner-active_record', '~> 1.8'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'slack-notifier', '~> 2'
+gem 'sqlite3', '~> 1.4'
+gem 'webmock', '~> 3.9'

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    changelog-notifier (1.4.0)
+      titleize (~> 1.4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.7)
+    crack (0.4.4)
+    database_cleaner (1.8.5)
+    database_cleaner-active_record (1.8.0)
+      activerecord
+      database_cleaner (~> 1.8.0)
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    slack-notifier (2.3.2)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    titleize (1.4.1)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    webmock (3.9.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 6.0)
+  changelog-notifier!
+  database_cleaner-active_record (~> 1.8)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  slack-notifier (~> 2)
+  sqlite3 (~> 1.4)
+  webmock (~> 3.9)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Guillaume Hain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,152 @@
+# changelog-notifier
+
+This gem reads [your `CHANGELOG.md` file](https://keepachangelog.com) and extract the release note for your project's version (fetched from your git tags) and posts it to a Slack channel when deploying your app with Capistrano.
+
+This allows you to keep informed your team about releases deployments.
+
+To summarize, it runs your `CHANGELOG.md` file into this:
+
+![](screenshots/changelog-notifiier_slack.png)
+
+## Concepts
+
+### Entrypoints
+
+[Entrypoints](https://gitlab.com/zedtux/changelog-notifier/-/tree/master/lib/changelog/notifier/entrypoints) are the inputs, or the triggers. As of now, only the Capistrano entrypoint exists, which means you can only publish your `CHANGELOG.md` *FROM* a Capistrano deployment.
+
+You can add any kind of entrypoints like a cron one, a bot and more!
+
+### Parsers
+
+[Parsers](https://gitlab.com/zedtux/changelog-notifier/-/tree/master/lib/changelog/notifier/parsers) are the heart of this gem, and are responsible to read and transform a `CHANGELOG.md` file into a standardized `Hash`.
+
+In other words they are transforming something like that:
+
+```
+## [1.1.0] - 2020-10-13
+### Added
+- Improves application name formatting in Slack adapter
+
+### Removed
+- All the bad code
+```
+
+Into that:
+
+```ruby
+{
+    version: '1.1.0',
+    date: '2020-10-13',
+    url: 'https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...v1.1.0',
+    changes: {
+      added: [
+        'Improves application name formatting in Slack adapter',
+      ],
+      removed: [
+        'All the bad code'
+      ]
+    }
+}
+```
+
+### Adapters
+
+[Adapters](https://gitlab.com/zedtux/changelog-notifier/-/tree/master/lib/changelog/notifier/adapters) are the output. Adapters are using [formatters](https://gitlab.com/zedtux/changelog-notifier/-/tree/master/lib/changelog/notifier/formatters) in order to transform the parsed `CHANGELOG.md` into something that can be used by the adapters.
+
+As of now, there are 2 supported adapters:
+
+* the Slack adapter which allows you to publish your `CHANGELOG.md` *TO* a Slack channel
+* the ActiveRecord which allows you to create an ActiveRecord into your database
+
+You can use many adapters at the same time so if you'd like to post to Slack *AND* to create an entry in your database, configures both and you'll get both!
+
+You can add adapters for anythings like Twitter, Mails, SMS, WhatsApp and more!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'changelog-notifier', '~> 1.4'
+gem 'slack-notifier', '~> 2' # For Slack notifications
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install changelog-notifier
+
+## Usage
+
+### First
+
+As of now there's only one [Entrypoint](#entrypoints) which is Capistrano, so you have to import the gem's Capistrano entrypoint:
+
+1. Add the following `require` to your `Capfile`
+```ruby
+require 'changelog/notifier/capistrano'
+```
+2. Add and configure the options in your `config/deploy.rb` file:
+```ruby
+# Where should changelog-notifier run?
+set :changelog_notifier_role, :app
+```
+
+### Using the Slack adapter
+
+3. Configure the Slack adapter:
+```ruby
+# Slack options
+#
+# Your webhook URL
+set :changelog_notifier_slack_webhook_url, 'https://hooks.slack.com/services/...'
+# The Slack channel where to post the release note
+set :changelog_notifier_slack_channel, '#general'
+# The Icon Emoji to be used when posting the release note
+set :changelog_notifier_slack_icon_emoji, ':package:'
+```
+
+### Using the ActiveRecord adapter
+
+3. Configure the ActiveRecord adapter:
+```ruby
+# ActiveRecord options
+#
+# Your ActiveRecord model name
+set :changelog_notifier_active_record_model, Release
+# The column/field from your ActiveRecord model where to set the version
+set :changelog_notifier_active_record_version_field, 'version'
+# The column/field from your ActiveRecord model where to store the release note
+set :changelog_notifier_active_record_release_node_field, 'release_note'
+# The columns/fields from your ActiveRecord model that you need to set (optional)
+set :changelog_notifier_active_record_other_fields, { field1: 'ok', field2: true }
+```
+
+### Finally
+
+3. Maintain your `CHANGELOG.md` file as described at https://keepachangelog.com
+4. Tag with your version
+5. Deploy with Capistrano
+
+When you will deploy a tagged commit, and a matching version exists in your `CHANGELOG.md` file, a Slack post will be sent in the case the Capistrano deployment suceeded.
+
+## Development
+
+After checking out the repo, and installed [Docker](https://docs.docker.com/get-docker/), run `docker build -t $(whoami)/changelog-notifier .` to build the development Docker image. Then, run `docker run --rm --volume "$PWD":/gem $(whoami)/changelog-notifier` to run the tests. You can also run `docker run --rm -it --volume "$PWD":/gem $(whoami)/changelog-notifier bin/console` for an interactive prompt that will allow you to experiment.
+
+To release a new version, update the version number in `version.rb`, and then run `docker run --rm --volume "$PWD":/gem $(whoami)/changelog-notifier release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and merge requests are welcome on Gitlab at https://gitlab.com/zedtux/changelog-notifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Changelog::Notifier project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/zedtux/changelog-notifier/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'changelog/notifier'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/changelog-notifier.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/changelog/notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'changelog-notifier'
+  spec.version       = Changelog::Notifier::VERSION
+  spec.authors       = ['Guillaume Hain']
+  spec.email         = ['zedtux@zedroot.org']
+
+  spec.summary       = "Sends current version's release note from your " \
+                       'CHANGELOG.md file'
+  spec.description   = 'This gem sends the release note, extracted from your ' \
+                       'CHANGELOG.md file, to Slack when deployin with ' \
+                       'Capistrano'
+  spec.homepage      = 'https://gitlab.com/zedtux/changelog-notifier'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://gitlab.com/zedtux/changelog-notifier'
+  spec.metadata['changelog_uri'] = 'https://gitlab.com/zedtux/changelog-notifier/-/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'titleize', '~> 1.4.1'
+end

data/lib/changelog/notifier.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'changelog/notifier/errors'
+require 'changelog/notifier/adapters/base'
+require 'changelog/notifier/adapters/active_record'
+require 'changelog/notifier/adapters/slack'
+require 'changelog/notifier/formatters/active_record'
+require 'changelog/notifier/formatters/slack'
+require 'changelog/notifier/git_commit_author_fetcher'
+require 'changelog/notifier/git_tag_fetcher'
+require 'changelog/notifier/parsers/markdown'
+require 'changelog/notifier/version'
+
+module Changelog
+  module Notifier
+  end
+end

data/lib/changelog/notifier/adapters/active_record.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Changelog
+  module Notifier
+    module Adapters
+      #
+      # Creates an ActiveRecord with the changelog
+      #
+      class ActiveRecord < Base
+        def publish!(release_note_hash, version)
+          formatted_release_note = format_release_note_hash(release_note_hash)
+
+          create_attributes = {}
+          create_attributes[version_field] = version
+          create_attributes[release_node_field] = formatted_release_note
+
+          Array(@other_fields).each do |field, value|
+            create_attributes[field] = value
+          end
+
+          @model.create!(create_attributes)
+        end
+
+        private
+
+        #
+        # Fetches all the configuration variables from Capistrano.
+        #
+        def fetches_adapter_configuration
+          @model = @capistrano.fetch(:changelog_notifier_active_record_model)
+          @version_field = @capistrano.fetch(
+            :changelog_notifier_active_record_version_field
+          )
+          @release_node_field = @capistrano.fetch(
+            :changelog_notifier_active_record_release_node_field
+          )
+          @other_fields = @capistrano.fetch(
+            :changelog_notifier_active_record_other_fields
+          )
+        end
+
+        def format_release_note_hash(release_note_hash)
+          Changelog::Notifier::Formatters::ActiveRecord.new(release_note_hash)
+                                                       .format
+        end
+
+        def release_node_field
+          @release_node_field || 'release_node'
+        end
+
+        def version_field
+          @version_field || 'version'
+        end
+      end
+    end
+  end
+end

data/lib/changelog/notifier/adapters/base.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Changelog
+  module Notifier
+    module Adapters
+      class Base
+        def initialize(capistrano)
+          @capistrano = capistrano
+
+          unless @capistrano
+            raise ArgumentError, 'No Capistrano instance passed while it is ' \
+                                 'required.'
+          end
+
+          fetches_adapter_configuration
+        end
+
+        def publish!(release_note_hash, version)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/changelog/notifier/adapters/slack.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'slack-notifier'
+
+module Changelog
+  module Notifier
+    module Adapters
+      #
+      # Slack adapter sends the release note in a Slack channel.
+      #
+      class Slack < Base
+        def publish!(release_note_hash, version)
+          formatted_release_note = format_release_note_hash(release_note_hash)
+
+          notifier = instantiate_slack_notifier
+
+          @capistrano.info "Posting #{version}'s release note in the " \
+                           "Slack #{channel} channel using the #{icon_emoji} " \
+                           'emoji icon ...'
+
+          notifier.post formatted_release_note
+        end
+
+        private
+
+        def channel
+          @channel || '#general'
+        end
+
+        #
+        # Fetches all the configuration variables from Capistrano.
+        #
+        def fetches_adapter_configuration
+          @webhook_url = @capistrano.fetch(
+            :changelog_notifier_slack_webhook_url
+          )
+          @channel = @capistrano.fetch(:changelog_notifier_slack_channel)
+          @icon_emoji = @capistrano.fetch(:changelog_notifier_slack_icon_emoji)
+        end
+
+        def format_release_note_hash(release_note_hash)
+          Changelog::Notifier::Formatters::Slack.new(release_note_hash).format
+        end
+
+        def icon_emoji
+          @icon_emoji || ':package:'
+        end
+
+        def instantiate_slack_notifier
+          ::Slack::Notifier.new(
+            @webhook_url,
+            channel: channel,
+            icon_emoji: icon_emoji,
+            username: 'ChangeLog Notifier'
+          )
+        end
+      end
+    end
+  end
+end

data/lib/changelog/notifier/capistrano.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'changelog/notifier/entrypoints/capistrano'
+require 'changelog/notifier/git_tag_fetcher'
+require 'changelog/notifier/git_commit_author_fetcher'
+require 'changelog/notifier/errors'
+require 'changelog/notifier/parsers/markdown'
+require 'changelog/notifier/adapters/slack'
+require 'changelog/notifier/formatters/slack'
+
+load File.expand_path('capistrano/tasks/changelog_notifier.rake', __dir__)

data/lib/changelog/notifier/capistrano/tasks/changelog_notifier.rake

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+namespace :load do
+  task :defaults do
+    set :changelog_notifier_role, :app
+
+    # Slack
+    set :changelog_notifier_slack_webhook_url, nil
+    set :changelog_notifier_slack_channel, '#general'
+    set :changelog_notifier_slack_icon_emoji, ':package:'
+
+    # ActiveRecord
+    set :changelog_notifier_active_record_model, nil # nil means disabled
+    set :changelog_notifier_active_record_version_field, 'version'
+    set :changelog_notifier_active_record_release_node_field, 'release_note'
+    set :changelog_notifier_active_record_other_fields, {}
+  end
+end
+
+namespace :deploy do
+  after :deploy, 'changelog_notifier:post_release_note'
+end
+
+namespace :changelog_notifier do
+  desc "Posts version's release notee do Slack"
+  task :post_release_note do
+    on roles(fetch(:changelog_notifier_role)) do
+      within current_path do
+        Changelog::Notifier::Entrypoints::Capistrano.run!(self)
+      end
+    end
+  end
+end

data/lib/changelog/notifier/entrypoints/capistrano.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Changelog
+  module Notifier
+    module Entrypoints
+      #
+      # Tries to publish the version's release note after a successful
+      # Capistrano deployment.
+      #
+      class Capistrano
+        def initialize(instance)
+          @capistrano = instance
+        end
+
+        def publish_release_note
+          ensure_release_has_changelog_file &&
+            fetch_version_from_git_tags_and_commit_author &&
+            parse_changelog_file &&
+            run_through_adapters
+        end
+
+        def self.run!(instance)
+          entrypoint = Changelog::Notifier::Entrypoints::Capistrano.new(instance)
+          entrypoint.publish_release_note
+        end
+
+        private
+
+        def ensure_release_has_changelog_file
+          return true if File.file?('CHANGELOG.md')
+
+          @capistrano.warn 'You repository has no CHANGELOG.md file. ' \
+                           'Skipping sending release note.'
+
+          false
+        end
+
+        def fetch_version_from_git_tags_and_commit_author
+          @git_repo_path = @capistrano.fetch(:repo_path)
+
+          @capistrano.info "Git dir is now #{@git_repo_path}."
+
+          fetch_version_from_git_tags && fetch_commit_author
+        end
+
+        def fetch_version_from_git_tags
+          # Retrives the current's commit version tag if any
+          @version = Changelog::Notifier::GitTagFetcher.fetch(
+            capistrano: @capistrano,
+            path: @git_repo_path
+          )
+
+          return true if @version
+
+          @capistrano.warn 'No version tag found from the currernt commit. ' \
+                           'Skipping sending release note.'
+
+          false
+        end
+
+        def fetch_commit_author
+          # Retrives the current's commit author
+          @author = Changelog::Notifier::GitCommitAuthorFetcher.fetch(
+            capistrano: @capistrano,
+            path: @git_repo_path
+          )
+
+          return true if @author
+
+          @capistrano.warn 'Commit author cannot be found from the currernt ' \
+                           ' commit. Skipping sending release note.'
+
+          false
+        end
+
+        def parse_changelog_file
+          parser = Changelog::Notifier::Parsers::Markdown.new(
+            File.read('CHANGELOG.md')
+          )
+
+          @release_note_hash = parser.extract(@version)
+
+          @release_note_hash[:author] = @author
+          @release_note_hash[:application] = @capistrano.fetch(
+            :application,
+            'the application'
+          )
+
+          true
+        rescue ArgumentError => error
+          @capistrano.error "Parsing CHANGELOG.md failed: #{error.message}. " \
+                            'Skipping sending release note.'
+        rescue Changelog::Notifier::ReleaseNoteNotFound
+          @capistrano.error 'Parsing CHANGELOG.md failed: Missing release ' \
+                            "note for version #{@version}." \
+                            'Skipping sending release note.'
+        end
+
+        def run_through_adapters
+          [
+            Changelog::Notifier::Adapters::ActiveRecord,
+            Changelog::Notifier::Adapters::Slack
+          ].each do |adapter|
+            adapter.new(@capistrano).publish!(@release_note_hash, @version)
+          end
+        rescue StandardError => error
+          @capistrano.error error.message
+        end
+      end
+    end
+  end
+end

data/lib/changelog/notifier/errors.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Changelog
+  module Notifier
+    # The CHANGELOG doesn't include the given version
+    class ReleaseNoteNotFound < StandardError; end
+    # A git command failed with an exit code higher than 0
+    class GitCommandFailed < StandardError; end
+
+    # A class is not implementing an expected method
+    class NotImplementedError < StandardError; end
+  end
+end

data/lib/changelog/notifier/formatters/active_record.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'titleize'
+
+module Changelog
+  module Notifier
+    module Formatters
+      #
+      # Format the given release note hash for ActiveRecord as a multiline text
+      #
+      class ActiveRecord
+        def initialize(release_note_hash)
+          @release_note_hash = release_note_hash
+        end
+
+        def format
+          release_note = description_text + "\n\n"
+
+          Array(@release_note_hash[:changes]).each do |change, logs|
+            release_note << "#{change.capitalize}\n#{logs.join("\n")}\n\n"
+          end
+
+          # TODO : Avoids adding newlines for the last change ...
+          release_note.gsub(/\n\z/, '')
+        end
+
+        private
+
+        def description_text
+          "*#{formatted_application_name}* version " \
+          "*#{@release_note_hash[:version]}* has just been released by " \
+          "*#{@release_note_hash[:author]}* on the " \
+          "*#{formatted_release_date}*.\nPlease find bellow the release note:"
+        end
+
+        def formatted_application_name
+          @release_note_hash[:application].gsub(/_/, ' ').titleize
+        end
+
+        def formatted_release_date
+          Date.parse(@release_note_hash[:date]).strftime('%b %d')
+        end
+      end
+    end
+  end
+end

data/lib/changelog/notifier/formatters/slack.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'titleize'
+
+module Changelog
+  module Notifier
+    module Formatters
+      #
+      # Format the given release note hash for Slack
+      #
+      class Slack
+        def initialize(release_note_hash)
+          @release_note_hash = release_note_hash
+        end
+
+        def format
+          {
+            attachments: build_attachments,
+            text: description_text
+          }
+        end
+
+        private
+
+        def build_attachments
+          Array(@release_note_hash[:changes]).map do |change, logs|
+            {
+              mrkdwn_in: ['text'],
+              color: color_for(change),
+              title: change.to_s.capitalize,
+              fields: logs.map { |log| { title: log } }
+            }
+          end
+        end
+
+        def color_for(change)
+          case change
+          when :added       then green
+          when :changed     then yellow
+          when :deprecated  then yellow
+          when :fixed       then green
+          when :removed     then red
+          when :security    then red
+          end
+        end
+
+        def description_text
+          "*#{formatted_application_name}* version " \
+          "*#{@release_note_hash[:version]}* has just been released by " \
+          "*#{@release_note_hash[:author]}* on the " \
+          "*#{formatted_release_date}*.\n\nPlease find bellow the release note:"
+        end
+
+        def formatted_application_name
+          @release_note_hash[:application].gsub(/_/, ' ').titleize
+        end
+
+        def formatted_release_date
+          Date.parse(@release_note_hash[:date]).strftime('%b %d')
+        end
+
+        def green
+          '#36a64f'
+        end
+
+        def red
+          '#fc464a'
+        end
+
+        def yellow
+          '#fd9134'
+        end
+      end
+    end
+  end
+end

data/lib/changelog/notifier/git_commit_author_fetcher.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Changelog
+  module Notifier
+    #
+    # Fetches a Git commit author from the current commit.
+    #
+    class GitCommitAuthorFetcher
+      def self.fetch(options = {})
+        output = options[:capistrano].capture(
+          "git --git-dir=#{options[:path] || '.'} log -1 --pretty=format:'%an'"
+        )
+
+        return nil if output.empty?
+
+        output.gsub(/(^\'|'$)/, '')
+      end
+    end
+  end
+end

data/lib/changelog/notifier/git_tag_fetcher.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Changelog
+  module Notifier
+    #
+    # Fetches a Git tag from the current commit being a version.
+    #
+    class GitTagFetcher
+      def self.fetch(options = {})
+        output = options[:capistrano].capture(
+          "git --git-dir #{options[:path] || '.'} tag --contains HEAD"
+        )
+
+        return nil if output.empty?
+
+        output.split("\n").detect { |tag| tag =~ /[\d\.]+/ }
+      end
+    end
+  end
+end

data/lib/changelog/notifier/parsers/markdown.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Changelog
+  module Notifier
+    module Parsers
+      #
+      # Parses the given `content` as Markdown following the specifications from
+      # https://keepachangelog.com.
+      #
+      class Markdown
+        def initialize(content)
+          @content = content
+        end
+
+        def extract(version)
+          version_is_valid?(version) || raise(ArgumentError, 'Invalid version')
+
+          parse!
+
+          version_release_note = detect_version_release_note_for(version)
+          version_release_note || raise(Changelog::Notifier::ReleaseNoteNotFound)
+
+          version_release_note_hash = create_hash_from(version_release_note)
+
+          url = fetch_version_url_for(version)
+          version_release_note_hash[:url] = url
+
+          version_release_note_hash
+        end
+
+        private
+
+        # See https://keepachangelog.com/en/1.0.0/#how
+        def change_types
+          %w[
+            added
+            changed
+            deprecated
+            removed
+            fixed
+            security
+          ]
+        end
+
+        def create_hash_from(version_release_note)
+          sections = version_release_note.split('### ')
+
+          # Removes trailing whitespaces
+          sections = sections.map { |section| section.gsub(/\s+$/, '') }
+
+          version, date = extract_version_and_date_from(sections.shift)
+
+          changes = extract_actions_from(sections)
+
+          { version: version, date: date, changes: changes }
+        end
+
+        def detect_version_release_note_for(version)
+          version_number = fetch_version_number_from(version)
+
+          @versions.detect do |changelog_version|
+            changelog_version.start_with?("#{version_number}]") ||
+              changelog_version.start_with?("#{version}]")
+          end
+        end
+
+        def extract_actions_from(sections)
+          sections.each_with_object({}) do |section, accumulator|
+            type, logs = section.match(/^(#{change_types.join('|')})\n(.*)/mi)
+                               &.captures
+
+            next unless type
+
+            type = type.downcase.to_sym
+
+            logs = logs.split(/\s+-/)
+                       .reject(&:empty?)
+                       .map { |log| log.gsub(/^\s+/, '') }
+                       .map { |log| log.gsub("\n", ' ') }
+
+            accumulator[type] = logs
+          end
+        end
+
+        def extract_version_and_date_from(section)
+          section.match(/([\d\.]+)\]\s+-\s+([\d+-]+)/)&.captures
+        end
+
+        def fetch_version_number_from(version)
+          version.match(/([\d\.]+)/)&.captures&.first
+        end
+
+        def fetch_version_url_for(version)
+          version_number = fetch_version_number_from(version)
+          @content.match(%r{\[#{version_number}\]: (https://[\S]+)})
+                 &.captures
+                 &.first
+        end
+
+        #
+        # Split the file on the double dashes, representing version sections.
+        #
+        def parse!
+          @versions = @content.split(/##\s\[/)
+        end
+
+        def version_is_valid?(version)
+          version =~ /[\d\.]+/
+        end
+      end
+    end
+  end
+end

data/lib/changelog/notifier/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Changelog
+  module Notifier
+    VERSION = '1.5.0'
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: changelog-notifier
+version: !ruby/object:Gem::Version
+  version: 1.5.0
+platform: ruby
+authors:
+- Guillaume Hain
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: titleize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+description: This gem sends the release note, extracted from your CHANGELOG.md file,
+  to Slack when deployin with Capistrano
+email:
+- zedtux@zedroot.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- changelog-notifier.gemspec
+- lib/changelog/notifier.rb
+- lib/changelog/notifier/adapters/active_record.rb
+- lib/changelog/notifier/adapters/base.rb
+- lib/changelog/notifier/adapters/slack.rb
+- lib/changelog/notifier/capistrano.rb
+- lib/changelog/notifier/capistrano/tasks/changelog_notifier.rake
+- lib/changelog/notifier/entrypoints/capistrano.rb
+- lib/changelog/notifier/errors.rb
+- lib/changelog/notifier/formatters/active_record.rb
+- lib/changelog/notifier/formatters/slack.rb
+- lib/changelog/notifier/git_commit_author_fetcher.rb
+- lib/changelog/notifier/git_tag_fetcher.rb
+- lib/changelog/notifier/parsers/markdown.rb
+- lib/changelog/notifier/version.rb
+- screenshots/changelog-notifiier_slack.png
+homepage: https://gitlab.com/zedtux/changelog-notifier
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/zedtux/changelog-notifier
+  source_code_uri: https://gitlab.com/zedtux/changelog-notifier
+  changelog_uri: https://gitlab.com/zedtux/changelog-notifier/-/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key:
+specification_version: 4
+summary: Sends current version's release note from your CHANGELOG.md file
+test_files: []