fastlane-plugin-changelog 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f20a927e35629cebe67c2446b4fb3b30e53a9616
-  data.tar.gz: 14107c6871ac6ec8bb38e13bbc99ab51bd35774b
+  metadata.gz: 8b3f23e18421455b7d1d85d01f42ad3417021681
+  data.tar.gz: ef0b316111c36cc87147d033378960f40282ee5a
 SHA512:
-  metadata.gz: f1aeea9be1799a28adafdb52255be92e42ed1b3804e28d4a11ad55cefaa45b5e7b8c5f4d701db4e1ab1ed37540c817c69080e74effc6adc65c6c9a63df1bf078
-  data.tar.gz: b4f404efec6a72a822b3306d72a61b5dc06fde25ae507b3a77526b527e142ebb3be2a9d000f7b340da2cf31708f6ccc456685b49fb060d13d38c52fd6b9737fa
+  metadata.gz: eec2930f9df64e9cc1dd80247568650d81185363922f4d48ad5dae45bfeeaef79434b3f01866ac55e77c4f9a269570fb90c45ce8ae1584e1e3d097bddcf8bb63
+  data.tar.gz: 287e063b596c7cc2b0a18e92397d770f92ac7fc4bdc4a0860be8f6b261e6e0ee49212418e9a55ff562eb0c7f1fb6db7a7a4ddf6fc1ed8a7884c77f3650374d99

data/README.md

@@ -22,10 +22,12 @@ Since [Keep a CHANGELOG](http://keepachangelog.com/) project proposes a well-def
 3. open `CHANGELOG.md` in your favourite text editor
 4. paste in proposed structure from [What’s a change log?](http://keepachangelog.com/)
 
+🤖  A feature request to automate this during installation has [been raised](https://github.com/fastlane/fastlane/issues/5736).
+
 ## Actions
 `fastlane-plugin-changelog` consists of 3 actions enabling you to manipulate `CHANGELOG.md` from [`fastlane`](https://fastlane.tools).
 
-### read_changelog
+### 📖  read_changelog
 
 Reads the content of a section from your project's `CHANGELOG.md` file. `CHANGELOG.md` must follow structure proposed by [Keep a CHANGELOG](http://keepachangelog.com/) project. 
 
@@ -43,7 +45,7 @@ read_changelog(
  
  Use the output of this action in conjunction with for example [`pilot`](https://github.com/fastlane/fastlane/tree/master/pilot#uploading-builds) to upload your change log to TestFlight or with [`github_release`](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Actions.md#github-releases) to create a new release on Github.
 
-### update_changelog
+### 📝  update_changelog
 Updates section identifier of your project's `CHANGELOG.md` file. 
 ``` ruby
 update_changelog(
@@ -52,9 +54,9 @@ update_changelog(
 )
 ```
  
-### stamp_changelog
+### 🔖  stamp_changelog
 Stamps the _Unreleased_ (see [How can I minimize the effort required?](http://keepachangelog.com/)) section with provided identifier in your project `CHANGELOG.md` file and sets up a new _Unreleased_ section above it.
-Additionally, you can provide git tag associated with this section. `stamp_changelog` will then create a link to diff between this and previous section's tag on Github. This will enable you to quickly get to [comparison between two tags](https://help.github.com/articles/comparing-commits-across-time/).
+Additionally, you can provide an optional `git_tag` param, specifing git tag associated with this section. `stamp_changelog` will then create a link to diff between this and previous section's tag on Github. This will enable you to quickly get to [comparison between two tags](https://help.github.com/articles/comparing-commits-across-time/).
 ``` ruby
 stamp_changelog(
   section_identifier: "Build XYZ", # Specify identifier to stamp the Unreleased section with 

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

@@ -47,7 +47,15 @@ module Fastlane
         markdownless_line = line
         excluded_markdown_elements.each do |element|
           if line =~ /^#{element}/
-            markdownless_line = markdownless_line.gsub(element.to_s, "")
+            indexOfElement = line.index(element)  
+            indexOfWhitespace = indexOfElement + element.to_s.length
+            
+            if line[indexOfWhitespace] == " " # remove white space (if any) following the markdown element
+              markdownless_line = markdownless_line.gsub(element.to_s + " ", "")  
+            else 
+              markdownless_line = markdownless_line.gsub(element.to_s, "")  
+            end
+            
           end
         end
 

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

@@ -1,16 +1,32 @@
 module Fastlane
   module Actions
     class StampChangelogAction < Action
+      UNRELEASED_IDENTIFIER = '[Unreleased]'
+
       def self.run(params)
+        # 1. Ensure CHANGELOG.md exists
         changelog_path = params[:changelog_path] unless params[:changelog_path].to_s.empty?
         UI.error("CHANGELOG.md at path '#{changelog_path}' does not exist") unless File.exist?(changelog_path)
 
-        # 1. Update [Unreleased] section with provided identifier
-        section_identifier = params[:section_identifier] unless params[:section_identifier].to_s.empty?
+        # 2. Ensure there are changes in [Unreleased] section
+        unreleased_section_content = Actions::ReadChangelogAction.run(changelog_path: changelog_path, section_identifier: UNRELEASED_IDENTIFIER)
+        if unreleased_section_content.eql?("\n")
+          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]
+          git_tag = params[:git_tag]
+          
+          stamp(changelog_path, section_identifier, stamp_date, git_tag)
+        end
+      end
+
+      def self.stamp(changelog_path, section_identifier, stamp_date, git_tag)
+        # 1. Update [Unreleased] section with given identifier
         Actions::UpdateChangelogAction.run(changelog_path: changelog_path,
-                                          section_identifier: "[Unreleased]",
+                                          section_identifier: UNRELEASED_IDENTIFIER,
                                           updated_section_identifier: section_identifier,
-                                          append_date: params[:stamp_date])
+                                          append_date: stamp_date)
 
         file_content = ""
 
@@ -37,13 +53,13 @@ module Fastlane
         end
 
         # 3. Create link to Github tags diff
-        if params[:git_tag] && !params[:git_tag].empty?
+        if !git_tag.nil? && !git_tag.empty?
           last_line = file_content.lines.last
           previous_section_name = last_line[/\[(.*?)\]/, 1]
           previous_previous_tag = %r{(?<=compare\/)(.*)?(?=\.{3})}.match(last_line)
           previous_tag = /(?<=\.{3})(.*)?/.match(last_line)
 
-          last_line.sub!(previous_tag.to_s, params[:git_tag]) # Replace previous tag with new
+          last_line.sub!(previous_tag.to_s, git_tag) # Replace previous tag with new
           last_line.sub!(previous_previous_tag.to_s, previous_tag.to_s) # Replace previous-previous tag with previous
           last_line.sub!(previous_section_name.to_s, section_identifier) # Replace section identifier
 

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

@@ -92,7 +92,7 @@ module Fastlane
                                        end),
           FastlaneCore::ConfigItem.new(key: :updated_section_identifier,
                                        env_name: "FL_UPDATE_CHANGELOG_UPDATED_SECTION_IDENTIFIER",
-                                       description: "The updated unique section identifier",
+                                       description: "The updated unique section identifier (without square brackets)",
                                        is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :append_date,

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Changelog
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-changelog
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Pavel Prochazka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-09 00:00:00.000000000 Z
+date: 2016-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry