fastlane-plugin-changelog 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e066c1d6080f5b420db6486b92b99b139fd7e558
-  data.tar.gz: 61d471439bd314f56e3a70653841c6b6cf8852d8
+  metadata.gz: 2e2a3068eec0233c38bcec3e8c1f0cc9487dec34
+  data.tar.gz: 94e86e6da58136da6ab607f14354029d9836fbc8
 SHA512:
-  metadata.gz: 0746da8916f3ed5d274701c8cfeb873ba0a34a63809d45b43bdeca5fc83b2bfa11e3dbfbf6d4d45ac8a759b3f2dce25d5d238fecf12ed7a075078d5e364ed354
-  data.tar.gz: 995ac63588bb1a574a773c85cea2b2055ef2bcea504af6ed5e3ae1c44ebb178723902481c1bbffcdf55c4ef3d9c1be37769219daf62271b356b0203c9d2dcf7c
+  metadata.gz: 3e1617f7c34fdce1e1cdcb8956df0fedffbccb828da1c5ca8f2ad49f9988e13b03fec5d43a1c271b788f7cb3f11a0ce81f17e34b85bec43bf0cf37879a1368bf
+  data.tar.gz: 6638d73d36df78ec25a1dae2f78c154f64e88c0bfa42c552227d6314d5d9404e8c75afc9534513bf708a32f2168f4b8fa7faa5b5dfa7119bb86faef9b78d5dfb

data/README.md

@@ -56,6 +56,69 @@ stamp_changelog(
 )
 ```
 
+### 😁 emojify_changelog
+Emojifies the output of `read_changelog` action. When you share changelog with the rest of your team on e.g.: Slack channel, it's nice to sprinkle your subsections with a bit of visuals so it immediately catches eyes of your teammates. `emojify_changelog` uses the output of `read_changelog` action to append an emoji to known subsections, for example:
+
+```
+Added:
+- New awesome feature
+
+Changed:
+- Onboarding flow 
+
+Fixed:
+- Fix Markdown links 
+
+Removed:
+- User tracking 
+
+Work In Progress:
+- Sales screen
+
+Security:
+- Enable SSL pinning
+
+Deprecated:
+- Obsolete contact screen
+```
+
+into
+
+
+```
+Added 🎁:
+- New awesome feature
+
+Changed ↔️:
+- Onboarding flow UI
+
+Fixed ✅:
+- Fix Markdown links 
+
+Removed 🚫:
+- User tracking 
+
+Work In Progress 🚧:
+- Sales screen
+
+Security 🔒:
+- Enable SSL pinning
+
+Deprecated 💨:
+- Obsolete contact screen
+```
+
+Example of use:
+``` ruby
+changelog = read_changelog # Read changelog
+pilot(changelog: changelog) # Send binary and changelog to TestFlight
+emojified_changelog = emojify_changelog
+slack(message: "Hey team, we have a new build for you, which includes the following: #{emojified_changelog}")
+
+```
+
+*NOTE*: do not send emojified changelog to iTunes Connect as it cannot handle emojies. 
+
 ## Example
 As a developer you have to **remember to keep your CHANGELOG.md up-to-date** with whatever features, bug fixes etc. your repo contains and let [`fastlane`](https://fastlane.tools) do the rest. 
 

data/lib/fastlane/plugin/changelog/actions/emojify_changelog.rb

@@ -0,0 +1,86 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      EMOJIFY_CHANGELOG_CONTENT = :EMOJIFY_CHANGELOG_CONTENT
+    end
+
+    class EmojifyChangelogAction < Action
+      SUBSECTION_IDENTIFIERS = ['Added', 'Changed', 'Fixed', 'Removed', 'Work In Progress', 'Security', 'Deprecated']
+
+      def self.run(params)
+        UI.message "Emojifying the output of read_changelog action"
+
+        read_changelog_output = lane_context[SharedValues::READ_CHANGELOG_SECTION_CONTENT]
+        changelog_path = lane_context[SharedValues::READ_CHANGELOG_CHANGELOG_PATH]
+
+        line_separator = Helper::ChangelogHelper.get_line_separator(changelog_path)
+        emojified_content = ""
+
+        # Read through read changelog output string
+        read_changelog_output.each_line do |line|
+          # Remove leading or trailing whitespaces
+          stripped = line.strip
+          # Remove trailing colon (if any)
+          if stripped.end_with?(':')
+            stripped.chop!
+            chopped_colon = true
+          end
+
+          if SUBSECTION_IDENTIFIERS.include?(stripped)
+            emojified_string = case stripped
+                               when 'Added' then 'Added 🎁'
+                               when 'Changed' then 'Changed ↔️'
+                               when 'Fixed' then 'Fixed ✅'
+                               when 'Removed' then 'Removed 🚫'
+                               when 'Work In Progress' then 'Work In Progress 🚧'
+                               when 'Security' then 'Security 🔒'
+                               when 'Deprecated' then 'Deprecated 💨'
+                               end
+
+            # Add back trailing colon, if previously removed
+            if chopped_colon
+              emojified_string.concat(':')
+            end
+
+            # Add line break to the end of the string, in order to start next line on the next line
+            emojified_string.concat(line_separator)
+
+            # Output updated line
+            emojified_content.concat(emojified_string)
+          else
+            # Output updated line
+            emojified_content.concat(line)
+          end
+        end
+
+        UI.success("Successfuly emojified output of read_changelog action")
+
+        Actions.lane_context[SharedValues::EMOJIFY_CHANGELOG_CONTENT] = emojified_content
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Emojifies the output of read_changelog action"
+      end
+
+      def self.details
+        "This action uses the output of read_changelog action to append an emoji to known subsections"
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.authors
+        ["pajapro"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/changelog/actions/read_changelog.rb

@@ -2,6 +2,7 @@ module Fastlane
   module Actions
     module SharedValues
       READ_CHANGELOG_SECTION_CONTENT = :READ_CHANGELOG_SECTION_CONTENT
+      READ_CHANGELOG_CHANGELOG_PATH = :READ_CHANGELOG_CHANGELOG_PATH
     end
 
     class ReadChangelogAction < Action
@@ -40,6 +41,7 @@ module Fastlane
 
         UI.success("Finished reading #{section_identifier} section from '#{changelog_path}'") unless section_content.empty?
 
+        Actions.lane_context[SharedValues::READ_CHANGELOG_CHANGELOG_PATH] = changelog_path
         Actions.lane_context[SharedValues::READ_CHANGELOG_SECTION_CONTENT] = section_content
       end
 

data/lib/fastlane/plugin/changelog/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Changelog
-    VERSION = "0.5.1"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-changelog
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Pavel Prochazka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-12 00:00:00.000000000 Z
+date: 2016-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -100,6 +100,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/fastlane/plugin/changelog/actions/emojify_changelog.rb
 - lib/fastlane/plugin/changelog/actions/read_changelog.rb
 - lib/fastlane/plugin/changelog/actions/stamp_changelog.rb
 - lib/fastlane/plugin/changelog/actions/update_changelog.rb