fastlane-plugin-changelog 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9156865d370699bcd9e4ee56e6c2c919c7ab61f1
-  data.tar.gz: 3d25f7e9595777e7808b855ed142b1d5a3914874
+  metadata.gz: 57b4471d6ae10ef7b6da62051f240fb79d9e427f
+  data.tar.gz: 2b694ab107d07ad643185320131bf20590b04707
 SHA512:
-  metadata.gz: 26c8b5983a3354e62a3afad98c03b20bd6f8e1f1a08d1f1fa8a7f1bad4b7e487e24760932f9fdf60a3b01a565703a1bfb51d5e02036e6297a42f96ba423c5b00
-  data.tar.gz: 55442dc03b622176772e3d6aba159cf1bc5154405132635d8d100501e11661d98e4d6688c65056f1884710c2c93e8d3944930d17019f73fa17257990e1a7de3c
+  metadata.gz: f00afaa4410d6b32a8ba12974983f7f5e3c7a53486d58f07a7f5a4bec44dbcddf9b6e055e96c8d2e5afd298d0f5624de02e156a07fa1da6b8bdfb74991d410d8
+  data.tar.gz: 01ef33dd468b606a62c224381fb68745fbea6743729fdb129fcc7eb9aaa4bb5e07696ce94684d75e721c81b97ea17065e104812ba47f79627792505af1bfdaf4

data/README.md

@@ -56,6 +56,8 @@ stamp_changelog(
 )
 ```
 
+🤖 Moreover, if you are using [danger-changelog](https://github.com/dblock/danger-changelog) plugin, you can leverage `placeholder_line` string paramater. `placeholder_line` string will be ignored when stamping an existing section _and_ copied into `[Unreleased]` section. This will help contributors to your project to see where changelog changes should be added (see [feature request](https://github.com/pajapro/fastlane-plugin-changelog/issues/22)). 
+
 ### 😁 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:
 

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

@@ -16,17 +16,19 @@ module Fastlane
           section_identifier = params[:section_identifier] unless params[:section_identifier].to_s.empty?
           stamp_date = params[:stamp_date]
           git_tag = params[:git_tag]
+          placeholder_line = params[:placeholder_line]
 
-          stamp(changelog_path, section_identifier, stamp_date, git_tag)
+          stamp(changelog_path, section_identifier, stamp_date, git_tag, placeholder_line)
         end
       end
 
-      def self.stamp(changelog_path, section_identifier, stamp_date, git_tag)
+      def self.stamp(changelog_path, section_identifier, stamp_date, 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)
+                                          append_date: stamp_date,
+                                          excluded_placeholder_line: placeholder_line)
 
         file_content = ""
 
@@ -37,7 +39,14 @@ module Fastlane
             # Find the first section identifier
             if !inserted_unreleased && line =~ /\#{2}\s?\[(.*?)\]/
               unreleased_section = "## [Unreleased]"
-              line = "#{unreleased_section}\n\n#{line}"
+
+              # Insert placeholder line (if provided)
+              if !placeholder_line.nil? && !placeholder_line.empty?
+                line = "#{unreleased_section}\n#{placeholder_line}\n\n#{line}"
+              else 
+                line = "#{unreleased_section}\n\n#{line}"
+              end  
+              
               inserted_unreleased = true
 
               UI.message("Created [Unreleased] placeholder section")
@@ -117,6 +126,11 @@ module Fastlane
                                        env_name: "FL_STAMP_CHANGELOG_GIT_TAG",
                                        description: "The git tag associated with this section",
                                        is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :placeholder_line,
+                                       env_name: "FL_STAMP_CHANGELOG_PLACEHOLDER_LINE",
+                                       description: "The placeholder line to be excluded in stamped section and added to [Unreleased] section",
+                                       is_string: true,
                                        optional: true)
         ]
       end

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

@@ -9,20 +9,40 @@ module Fastlane
         escaped_section_identifier = section_identifier[/\[(.*?)\]/, 1]
 
         new_section_identifier = params[:updated_section_identifier] unless params[:updated_section_identifier].to_s.empty?
+        excluded_placeholder_line = params[:excluded_placeholder_line] unless params[:excluded_placeholder_line].to_s.empty?
 
         UI.message "Starting to update #{section_identifier} section of '#{changelog_path}'"
 
         # Read & update file content
         file_content = ""
+        found_identifying_section = false
+
         File.open(changelog_path, "r") do |file|
           line_separator = Helper::ChangelogHelper.get_line_separator(changelog_path)
           file.each_line do |line|
-            # Find line matching section identifier
+
+            # 3. Ignore placeholder line (if provided) within the updated section
+            if found_identifying_section && !excluded_placeholder_line.nil?
+              if isSectionLine(line)
+                found_identifying_section = false # Reached the end of section, hence stop reading
+              else
+                if line =~ /^#{excluded_placeholder_line}/
+                  next # Ignore placeholder line, don't output it
+                else 
+                  file_content.concat(line) # Output unmodified line
+                  next
+                end
+              end
+            end
+
+            # 1. Find line matching section identifier
             if line =~ /\#{2}\s?\[#{escaped_section_identifier}\]/
               found_identifying_section = true
+            else
+              found_identifying_section = false
             end
 
-            # Update section identifier (if found)
+            # 2. Update section identifier (if found)
             if !new_section_identifier.empty? && found_identifying_section
               section_name = section_identifier[/\[(.*?)\]/, 1]
 
@@ -44,8 +64,6 @@ module Fastlane
               next
             end
 
-            # TODO: implement updating of section content
-
             # Output read line
             file_content.concat(line)
           end
@@ -58,6 +76,10 @@ module Fastlane
         UI.success("Successfuly updated #{changelog_path}")
       end
 
+      def self.isSectionLine(line)
+         line =~ /\#{2}\s?\[.*\]/
+      end
+
       #####################################################
       # @!group Documentation
       #####################################################
@@ -97,6 +119,11 @@ module Fastlane
                                        env_name: "FL_UPDATE_CHANGELOG_APPEND_DATE",
                                        description: "Appends the current date in YYYY-MM-DD format after the section identifier",
                                        default_value: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :excluded_placeholder_line,
+                                       env_name: "FL_UPDATE_CHANGELOG_EXCLUDED_PLACEHOLDER_LINE",
+                                       description: "Placeholder string to be ignored in updated section",
+                                       is_string: true,
                                        optional: true)
           # FastlaneCore::ConfigItem.new(key: :updated_section_content,
           #                              env_name: "FL_UPDATE_CHANGELOG_UPDATED_SECTION_CONTENT",

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Changelog
-    VERSION = "0.8.0"
+    VERSION = "0.9.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-changelog
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Pavel Prochazka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-11 00:00:00.000000000 Z
+date: 2017-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler