fastlane-plugin-changelog 0.11.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed97f77f8e92c6d2ebd8337d3ee0438043c701a3
-  data.tar.gz: 6ef8f3f6ed9088f5226e0405a264f2e1acb7bcbc
+  metadata.gz: 88dc3f6cc69c73c660b54513b941382eda0f8866
+  data.tar.gz: bc40d6fe17cebb7a3ae63ffac3a2fe1f8a9a9a12
 SHA512:
-  metadata.gz: 7db3e33068d51c4040fb524f324e1d8b17de94f31bf082ad3a306d83a3745f6a12526985eee2e6f3c311a61334b4e054b2678fe937c635678b275757fe3a1631
-  data.tar.gz: 7cc5e73f9d940def85ab869404aa6bf706f64805a08cab80acb554cb3d4065c21d46673e684632bec4b527a77f8a3a498626dfd7922a69c141ac3627979eb684
+  metadata.gz: 691abf1f00864a292359498499cf6af7b1fb308373f268ba7ac440e04ef73016af2ccb575190fa5b7c294c549be53e4806790a97809778d233cd65814e166033
+  data.tar.gz: 5ee732505ba076fd8bff381ade7e0ff6041f78edad5cb9a2160aca477e1c2d241102b07029086e65c51fc611f09afdd5dc7e6ae35cede277195bca694583d745

data/README.md

@@ -14,7 +14,7 @@ fastlane add_plugin changelog
 
 This plugin is inspired by and based on [Keep a CHANGELOG](http://keepachangelog.com/) project. [Keep a CHANGELOG](http://keepachangelog.com/) proposes a standardised format for keeping change log of your project repository in `CHANGELOG.md` file. This file contains a curated, chronologically ordered list of notable changes for each version of a project in human readable format.
 
-Since [Keep a CHANGELOG](http://keepachangelog.com/) project proposes a well-defined structure with _sections_ (e.g.: `[Unreleased]`, `0.3.0]`) and _subsections_ (`Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`) it opens up an opportunity to automate reading from/writing to `CHANGELOG.md` with [`fastlane`](https://fastlane.tools). 
+Since [Keep a CHANGELOG](http://keepachangelog.com/) project proposes a well-defined structure with _sections_ (e.g.: `[Unreleased]`, `[0.3.0]`) and _subsections_ (`Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`) it opens up an opportunity to automate reading from/writing to `CHANGELOG.md` with [`fastlane`](https://fastlane.tools). 
 
 ## Actions
 `fastlane-plugin-changelog` consists of 3 actions enabling you to manipulate `CHANGELOG.md` from [`fastlane`](https://fastlane.tools).
@@ -52,7 +52,8 @@ Additionally, you can provide an optional `git_tag` param, specifing git tag ass
 ``` ruby
 stamp_changelog(
   section_identifier: 'Build XYZ', # Specify identifier to stamp the Unreleased section with 
-  git_tag: 'bXYZ' # Specify reference to git tag associated with this section
+  git_tag: 'bXYZ', # Specify reference to git tag associated with this section
+  stamp_date: true # Specify whether current date should be appended to stamped section line (default is `true`)
 )
 ```
 
@@ -87,26 +88,26 @@ Deprecated:
 emojifies into:
 
 ```
-Added 🎁:
-- New awesome feature
+*Added* 🎁:
+• New awesome feature
 
-Changed ↔️:
-- Onboarding flow UI
+*Changed* ↔️:
+• Onboarding flow UI
 
-Fixed ✅:
-- Fix Markdown links 
+*Fixed* ✅:
+• Fix Markdown links 
 
-Removed 🚫:
-- User tracking 
+*Removed* 🚫:
+• User tracking 
 
-Work In Progress 🚧:
-- Sales screen
+*Work In Progress* 🚧:
+• Sales screen
 
-Security 🔒:
-- Enable SSL pinning
+*Security* 🔒:
+• Enable SSL pinning
 
-Deprecated 💨:
-- Obsolete contact screen
+*Deprecated* 💨:
+• Obsolete contact screen
 ```
 
 Example of use:

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

@@ -28,14 +28,14 @@ module Fastlane
 
           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
+                                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
@@ -49,11 +49,15 @@ module Fastlane
             emojified_content.concat(emojified_string)
           else
             # Output updated line
+            # Replace '-' with '*'
+            if line.start_with?('-')
+              line[0] = '•'
+            end
             emojified_content.concat(line)
           end
         end
 
-        UI.success("Successfuly emojified output of read_changelog action")
+        UI.success("Successfully emojified output of read_changelog action")
 
         Actions.lane_context[SharedValues::EMOJIFY_CHANGELOG_CONTENT] = emojified_content
       end
@@ -74,6 +78,12 @@ module Fastlane
         []
       end
 
+      def self.output
+        [
+          ['EMOJIFY_CHANGELOG_CONTENT', 'Contains the emojified content of the last read_changelog action'],
+        ]
+      end
+
       def self.authors
         ["pajapro"]
       end

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

@@ -103,7 +103,8 @@ module Fastlane
 
       def self.output
         [
-          ['READ_CHANGELOG_SECTION_CONTENT', 'Contains text from a section of your CHANGELOG.md file']
+          ['READ_CHANGELOG_SECTION_CONTENT', 'Contains text from a section of your CHANGELOG.md file'],
+          ['READ_CHANGELOG_CHANGELOG_PATH', 'Contains the path to the CHANGELOG.md file']
         ]
       end
 

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

@@ -14,20 +14,22 @@ module Fastlane
           UI.important("WARNING: No changes in [Unreleased] section to stamp!")
         else
           section_identifier = params[:section_identifier] unless params[:section_identifier].to_s.empty?
-          stamp_date = params[:stamp_date]
+          should_stamp_date = params[:should_stamp_date]
+          stamp_datetime_format = params[:stamp_datetime_format]
           git_tag = params[:git_tag]
           placeholder_line = params[:placeholder_line]
 
-          stamp(changelog_path, section_identifier, stamp_date, git_tag, placeholder_line)
+          stamp(changelog_path, section_identifier, should_stamp_date, stamp_datetime_format, git_tag, placeholder_line)
         end
       end
 
-      def self.stamp(changelog_path, section_identifier, stamp_date, git_tag, placeholder_line)
+      def self.stamp(changelog_path, section_identifier, should_stamp_date, stamp_datetime_format, git_tag, placeholder_line)
         # 1. Update [Unreleased] section with given identifier
         Actions::UpdateChangelogAction.run(changelog_path: changelog_path,
                                           section_identifier: UNRELEASED_IDENTIFIER,
                                           updated_section_identifier: section_identifier,
-                                          append_date: stamp_date,
+                                          should_append_date: should_stamp_date,
+                                          append_datetime_format: stamp_datetime_format,
                                           excluded_placeholder_line: placeholder_line)
 
         file_content = ""
@@ -64,27 +66,33 @@ module Fastlane
         # 3. Create link to git tags diff
         if !git_tag.nil? && !git_tag.empty?
           last_line = file_content.lines.last
-          previous_tag = ""
-          previous_previous_tag = ""
+          previous_tag = ''
+          previous_previous_tag = ''
+          reversed_tags = false
 
           if last_line.include? 'https://github.com' # GitHub uses compare/olderTag...newerTag structure
             previous_previous_tag = %r{(?<=compare\/)(.*)?(?=\.{3})}.match(last_line)
             previous_tag = /(?<=\.{3})(.*)?/.match(last_line)
           elsif last_line.include? 'https://bitbucket.org' # Bitbucket uses compare/newerTag..olderTag structure
+            reversed_tags = true
             previous_tag = %r{(?<=compare\/)(.*)?(?=\.{2})}.match(last_line)
             previous_previous_tag = /(?<=\.{2})(.*)?/.match(last_line)
           end
 
           # Replace section identifier
-          cleared_git_tag = git_tag.delete('[a-z]')
-          cleared_previous_git_tag = previous_tag.to_s.delete('[a-z]')
-          last_line.sub!("[#{cleared_previous_git_tag}]", "[#{cleared_git_tag}]")
-
-          # Replace previous-previous tag with previous
-          last_line.sub!(previous_previous_tag.to_s, previous_tag.to_s)
-
-          # Replace previous tag with new
-          last_line.sub!("..#{previous_tag}", "..#{git_tag}")
+          previous_section_identifier = /(?<=\[)[^\]]+(?=\]:)/.match(last_line)
+          last_line.sub!("[#{previous_section_identifier}]:", "[#{section_identifier}]:")
+
+          # Replace first tag
+          last_line.sub!(
+            reversed_tags ? previous_tag.to_s : previous_previous_tag.to_s,
+            reversed_tags ? git_tag.to_s : previous_tag.to_s
+          )
+          # Replace second tag
+          last_line.sub!(
+            "..#{reversed_tags ? previous_previous_tag : previous_tag}",
+            "..#{reversed_tags ? previous_tag : git_tag}"
+          )
 
           UI.message("Created a link for comparison between #{previous_tag} and #{git_tag} tag")
 
@@ -95,7 +103,7 @@ module Fastlane
         changelog = File.open(changelog_path, "w")
         changelog.puts(file_content)
         changelog.close
-        UI.success("Successfuly stamped #{section_identifier} in #{changelog_path}")
+        UI.success("Successfully stamped #{section_identifier} in #{changelog_path}")
       end
 
       #####################################################
@@ -123,10 +131,17 @@ module Fastlane
                                        env_name: "FL_STAMP_CHANGELOG_SECTION_IDENTIFIER",
                                        description: "The unique section identifier to stamp the [Unreleased] section with",
                                        is_string: true),
-          FastlaneCore::ConfigItem.new(key: :stamp_date,
-                                       env_name: "FL_STAMP_CHANGELOG_SECTION_STAMP_DATE",
-                                       description: "Specifies whether the current date should be appended to section identifier",
+          FastlaneCore::ConfigItem.new(key: :should_stamp_date,
+                                       env_name: "FL_STAMP_CHANGELOG_SHOULD_STAMP_DATE",
+                                       description: "Specifies whether the current date as per the stamp_datetime_format should be stamped to the section identifier",
                                        default_value: true,
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :stamp_datetime_format,
+                                       env_name: "FL_STAMP_CHANGELOG_DATETIME_FORMAT",
+                                       description: "The strftime format string to use for the date in the stamped section",
+                                       default_value: '%FZ',
+                                       is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :git_tag,
                                        env_name: "FL_STAMP_CHANGELOG_GIT_TAG",

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

@@ -48,8 +48,14 @@ module Fastlane
               line_old = line.dup
               line.sub!(section_name, new_section_identifier)
 
-              if params[:append_date]
-                now = Time.now.strftime("%Y-%m-%d")
+              should_append_date = params[:should_append_date]
+
+              if should_append_date
+                append_datetime_format = params[:append_datetime_format]
+
+                now = Time.now.utc.strftime(append_datetime_format)
+                ENV["FL_UPDATE_APPEND_DATETIME_VAL"] = now
+
                 line.concat(" - " + now)
                 line.delete!(line_separator) # remove line break, because concatenation adds line break between section identifer & date
                 line.concat(line_separator) # add line break to the end of the string, in order to start next line on the next line
@@ -72,7 +78,7 @@ module Fastlane
         changelog = File.open(changelog_path, "w")
         changelog.puts(file_content)
         changelog.close
-        UI.success("Successfuly updated #{changelog_path}")
+        UI.success("Successfully updated #{changelog_path}")
       end
 
       def self.is_section_line(line)
@@ -114,10 +120,17 @@ module Fastlane
                                        description: "The updated unique section identifier (without square brackets)",
                                        is_string: true,
                                        optional: true),
-          FastlaneCore::ConfigItem.new(key: :append_date,
-                                       env_name: "FL_UPDATE_CHANGELOG_APPEND_DATE",
-                                       description: "Appends the current date in YYYY-MM-DD format after the section identifier",
+          FastlaneCore::ConfigItem.new(key: :should_append_date,
+                                       env_name: "FL_UPDATE_CHANGELOG_SHOULD_APPEND_DATE",
+                                       description: "Specifies whether the current date as per the append_datetime_format should be appended to section identifier",
                                        default_value: true,
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :append_datetime_format,
+                                       env_name: "FL_UPDATE_CHANGELOG_APPEND_DATETIME_FORMAT",
+                                       description: "The strftime format string to use for the date after the section identifier",
+                                       default_value: '%FZ',
+                                       is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :excluded_placeholder_line,
                                        env_name: "FL_UPDATE_CHANGELOG_EXCLUDED_PLACEHOLDER_LINE",

data/lib/fastlane/plugin/changelog/helper/changelog_helper.rb

@@ -65,7 +65,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
       # Writes given content to CHANGELOG.md in project root
       def self.write_to_changelog(changelog)
         File.open(CHANGELOG_PATH, 'w') { |f| f.write(changelog) }
-        FastlaneCore::UI.success('Successfuly created CHANGELOG.md')
+        FastlaneCore::UI.success('Successfully created CHANGELOG.md')
       end
 
       def self.get_line_separator(file_path)

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Changelog
-    VERSION = "0.11.0"
+    VERSION = "0.16.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-changelog
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Pavel Prochazka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-16 00:00:00.000000000 Z
+date: 2021-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Automate changes to your project CHANGELOG.md