fastlane-plugin-changelog 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 403f4a4eb9682c5266b064684cee9bd8229d6fa8
-  data.tar.gz: 791cb83f660b2d973251645b8ce15864d270f7e4
+  metadata.gz: b883277c01f1eb86a19ccf42c0259d8f547db604
+  data.tar.gz: 3ef67394585bda5bbe554d797affec33f42d27a0
 SHA512:
-  metadata.gz: 0648cc5b024200347b5e152c0eddbcd9acb72e4f6f0c981ac8d8e69bb867ce02a9ddeab78bff6364019779d2fb1fdf74befed8497be608b9eeeb8f92e958eb0b
-  data.tar.gz: c72e5212b39488c5a2742f5436045557a12507e0900016ff5cb9cd36823d4fe5f607ef2451761507ac70c076291ba2c434a4a1436508adcf55daf1ec4f37543c
+  metadata.gz: a6ae79e34c359159db1ea95313f60e4fcffaa5ee39fb209a3908ad60ebd9555c7fcb3d356c6c13f6dc09a50859eb717df7f571dd78d2a0792f8c02e952713fec
+  data.tar.gz: fa57810df72f423449d943ee7222192eb8062befa558e16455a3dc3aa9eb53a6b3e25b9d15b726eaa8e4c1d6d2ff90e9af225fdeccd9aa4abb284f67cace7e3e

data/README.md

@@ -12,24 +12,25 @@ fastlane add_plugin changelog
 
 ## About changelog
 
-This plugin is inspired 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.
+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). 
 
 ## Getting started
 1. `cd` to your project folder
 2. `touch CHANGELOG.md`
-3. open CHANGELOG.md in your favourite text editor
-4. paste the following: `## [Unreleased]`
+3. open `CHANGELOG.md` in your favourite text editor
+4. paste in proposed structure from [What’s a change log?](http://keepachangelog.com/)
 
 ## Actions
+`fastlane-plugin-changelog` consists of 3 actions enabling you to manipulate `CHANGELOG.md` from [`fastlane`](https://fastlane.tools).
 
 ### 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. 
 
 ``` ruby
-read_changelog	# Reads the "Unreleased" section from CHANGELOG.md in your project's folder
+read_changelog	# Reads the Unreleased section from CHANGELOG.md in your project's folder
 ```
 
 ``` ruby
@@ -41,20 +42,38 @@ 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.
- 
-### write_changelog
-*Coming soon*
 
+### update_changelog
+Updates section identifier of your project's `CHANGELOG.md` file. 
+``` ruby
+update_changelog(
+  section_identifier: "[Build 123]", # Specify what section to update
+  updated_section_identifier: "Build 321" # Specify new section identifier
+)
+```
+ 
+### 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. 
+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/).
+``` 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
+)
+```
 
 ## 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) to do the rest. 
+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. 
 
 ``` ruby
 lane :beta do
-  gym
-  changelog = read_changelog
-  pilot(changelog: changelog)
-  # write_changelog
+  build_number = get_build_number # Get build number
+  gym # Compile
+  
+  changelog = read_changelog # Read changelog
+  pilot(changelog: changelog) # Send binary and changelog to TestFlight
+  
+  stamp_changelog(section_identifier: "Build #{build_number}") # Stamp Unreleased section with newly released build number
 end
 ```
 

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

@@ -5,13 +5,12 @@ module Fastlane
     end
 
     class ReadChangelogAction < Action
-
-      def self.run(params) 
-        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))
+      def self.run(params)
+        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)
         
-        section_identifier = params[:section_identifier] unless (params[:section_identifier].to_s.empty?)
-        escaped_section_identifier = section_identifier[/\[(.*?)\]/,1]
+        section_identifier = params[:section_identifier] unless params[:section_identifier].to_s.empty?
+        escaped_section_identifier = section_identifier[/\[(.*?)\]/, 1]
 
         excluded_markdown_elements = params[:excluded_markdown_elements]
 
@@ -21,27 +20,25 @@ module Fastlane
         found_section = false
         File.open(changelog_path, "r") do |file|
           file.each_line do |line|
-
             if found_section
               break if line =~ /\#{2}\s?\[(.*?)\]/
               if !excluded_markdown_elements.nil? && !excluded_markdown_elements.empty?
                 markdownless_line = remove_markdown(line, excluded_markdown_elements)
                 section_content.concat(markdownless_line)
-              else 
+              else
                 section_content.concat(line)
-              end 
-            end 
+              end
+            end
 
             if line =~ /\#{2}\s?\[#{escaped_section_identifier}\]/
               found_section = true
             end
-
           end
         end
 
-        UI.error("Could not find #{section_identifier} section in your CHANGELOG.md") unless (!section_content.empty?)
+        UI.error("Could not find #{section_identifier} section in your CHANGELOG.md") if section_content.empty?
 
-        UI.success("Finished reading #{section_identifier} section from '#{changelog_path}'") unless (section_content.empty?)
+        UI.success("Finished reading #{section_identifier} section from '#{changelog_path}'") unless section_content.empty?
 
         Actions.lane_context[SharedValues::READ_CHANGELOG_SECTION_CONTENT] = section_content
       end
@@ -52,7 +49,7 @@ module Fastlane
           if line =~ /^#{element}/
             markdownless_line = markdownless_line.gsub(element.to_s, "")
           end
-        end 
+        end
 
         markdownless_line
       end
@@ -66,9 +63,7 @@ module Fastlane
       end
 
       def self.details
-        "This action is inspired by \"Keep a CHANGELOG\" project (see http://keepachangelog.com/). \"Keep a CHANGELOG\" introduces a structed CHANGELOG.md file, 
-        which contains a curated, chronologically ordered list of notable changes for each version of a project. Use this action to read content of a section 
-        from your project's CHANGELOG.md."
+        "Use this action to read content of an arbitrary section from your project CHANGELOG.md"
       end
 
       def self.available_options
@@ -77,7 +72,7 @@ module Fastlane
                                        env_name: "FL_READ_CHANGELOG_PATH_TO_CHANGELOG",
                                        description: "The path to your project CHANGELOG.md",
                                        is_string: true,
-                                       default_value: "./CHANGELOG.md", 
+                                       default_value: "./CHANGELOG.md",
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :section_identifier,
                                        env_name: "FL_READ_CHANGELOG_SECTION_IDENTIFIER",
@@ -86,8 +81,8 @@ module Fastlane
                                        default_value: "[Unreleased]",
                                        optional: true,
                                        verify_block: proc do |value|
-                                          UI.user_error!("Sections (##) in CHANGELOG format must be encapsulated in []") unless (value.start_with?("[") && value.end_with?("]"))
-                                          UI.user_error!("Sections (##) in CHANGELOG format cannot be empty") unless (!value[/\[(.*?)\]/,1].empty?)
+                                         UI.user_error!("Sections (##) in CHANGELOG format must be encapsulated in []") unless value.start_with?("[") && value.end_with?("]")
+                                         UI.user_error!("Sections (##) in CHANGELOG format cannot be empty") if value[/\[(.*?)\]/, 1].empty?
                                        end),
           FastlaneCore::ConfigItem.new(key: :excluded_markdown_elements,
                                        env_name: "FL_READ_CHANGELOG_EXCLUDED_MARKDOWN_ELEMENTS",

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

@@ -0,0 +1,103 @@
+module Fastlane
+  module Actions
+    class StampChangelogAction < Action
+      def self.run(params)
+        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?
+        Actions::UpdateChangelogAction.run(changelog_path: changelog_path,
+                                          section_identifier: "[Unreleased]",
+                                          updated_section_identifier: section_identifier)
+
+        file_content = ""
+
+        # 2. Create new [Unreleased] section (placeholder)
+        inserted_unreleased = false
+        File.open(changelog_path, "r") do |file|
+          file.each_line do |line|
+            # Find the first section identifier
+            if !inserted_unreleased && line =~ /\#{2}\s?\[(.*?)\]/
+              unreleased_section = "## [Unreleased]"
+              line = "#{unreleased_section}\n\n#{line}"
+              inserted_unreleased = true
+
+              UI.message("Created [Unreleased] placeholder section")
+
+              # Output updated line
+              file_content.concat(line)
+              next
+            end
+
+            # Output read line
+            file_content.concat(line)
+          end
+        end
+
+        # 3. Create link to Github tags diff
+        unless params[: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_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
+
+          UI.message("Created link to Github tags diff")
+
+          file_content.concat(last_line)
+        end
+
+        # 4. Write updated content to file
+        changelog = File.open(changelog_path, "w")
+        changelog.puts(file_content)
+        changelog.close
+        UI.success("Successfuly stamped #{section_identifier} in #{changelog_path}")
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Stamps the [Unreleased] section with provided identifier in your project CHANGELOG.md file"
+      end
+
+      def self.details
+        "Use this action to stamp the [Unreleased] section with provided identifier in your project CHANGELOG.md. Additionally, you can provide git tag
+        associated with this section. `stamp_changelog` will then create a new link to diff between this and previous section's tag on Github"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :changelog_path,
+                                       env_name: "FL_STAMP_CHANGELOG_PATH_TO_CHANGELOG",
+                                       description: "The path to your project CHANGELOG.md",
+                                       is_string: true,
+                                       default_value: "./CHANGELOG.md",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :section_identifier,
+                                       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: :git_tag,
+                                       env_name: "FL_STAMP_CHANGELOG_GIT_TAG",
+                                       description: "The git tag associated with this section",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.authors
+        ["pajapro"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+module Fastlane
+  module Actions
+    class UpdateChangelogAction < Action
+      def self.run(params)
+        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)
+        
+        section_identifier = params[:section_identifier] unless params[:section_identifier].to_s.empty?
+        escaped_section_identifier = section_identifier[/\[(.*?)\]/, 1]
+
+        new_section_identifier = params[:updated_section_identifier] unless params[:updated_section_identifier].to_s.empty?
+        # new_section_content = params[:updated_section_content] unless (params[:updated_section_content].to_s.empty?)
+        
+        UI.message "Starting to update #{section_identifier} section of '#{changelog_path}'"
+
+        # Read & update file content
+        file_content = ""
+        File.open(changelog_path, "r") do |file|
+          file.each_line do |line|
+            # Find line matching section identifier
+            if line =~ /\#{2}\s?\[#{escaped_section_identifier}\]/
+              found_identifying_section = true
+            end
+
+            # Update section identifier (if found)
+            if !new_section_identifier.empty? && found_identifying_section
+              section_name = section_identifier[/\[(.*?)\]/, 1]
+
+              line_old = line.dup
+              line.sub!(section_name, new_section_identifier)
+              found_identifying_section = false
+              
+              UI.message "Old section identifier: #{line_old.delete!("\n")}"
+              UI.message "New section identifier: #{line.delete("\n")}"
+
+              # Output updated line
+              file_content.concat(line)
+              next
+            end
+
+            # TODO: implement updating of section content
+
+            # Output read line
+            file_content.concat(line)
+          end
+        end
+
+        # Write updated content to file
+        changelog = File.open(changelog_path, "w")
+        changelog.puts(file_content)
+        changelog.close
+        UI.success("Successfuly updated #{changelog_path}")
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Updates content of a section of your project CHANGELOG.md file"
+      end
+
+      def self.details
+        "Use this action to update content of an arbitrary section of your project CHANGELOG.md"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :changelog_path,
+                                       env_name: "FL_UPDATE_CHANGELOG_PATH_TO_CHANGELOG",
+                                       description: "The path to your project CHANGELOG.md",
+                                       is_string: true,
+                                       default_value: "./CHANGELOG.md",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :section_identifier,
+                                       env_name: "FL_UPDATE_CHANGELOG_SECTION_IDENTIFIER",
+                                       description: "The unique section identifier to update content of",
+                                       is_string: true,
+                                       default_value: "[Unreleased]",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Sections (##) in CHANGELOG format must be encapsulated in []") unless value.start_with?("[") && value.end_with?("]")
+                                         UI.user_error!("Sections (##) in CHANGELOG format cannot be empty") if value[/\[(.*?)\]/, 1].empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :updated_section_identifier,
+                                       env_name: "FL_UPDATE_CHANGELOG_UPDATED_SECTION_IDENTIFIER",
+                                       description: "The updated unique section identifier",
+                                       is_string: true,
+                                       optional: true)
+          # FastlaneCore::ConfigItem.new(key: :updated_section_content,
+          #                              env_name: "FL_UPDATE_CHANGELOG_UPDATED_SECTION_CONTENT",
+          #                              description: "The updated section content",
+          #                              is_string: true,
+          #                              optional: true)
+        ]
+      end
+
+      def self.authors
+        ["pajapro"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Changelog
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-changelog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pavel Prochazka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-25 00:00:00.000000000 Z
+date: 2016-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -100,8 +100,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/fastlane/plugin/changelog/actions/changelog_action.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
 - lib/fastlane/plugin/changelog/helper/changelog_helper.rb
 - lib/fastlane/plugin/changelog/version.rb
 - lib/fastlane/plugin/changelog.rb

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

@@ -1,35 +0,0 @@
-module Fastlane
-  module Actions
-    class ChangelogAction < Action
-      def self.run(params)
-        UI.message("The changelog plugin is working!")
-      end
-
-      def self.description
-        "Automate changes to your project CHANGELOG.md"
-      end
-
-      def self.authors
-        ["Pavel Prochazka"]
-      end
-
-      def self.available_options
-        [
-          # FastlaneCore::ConfigItem.new(key: :your_option,
-          #                         env_name: "CHANGELOG_YOUR_OPTION",
-          #                      description: "A description of your option",
-          #                         optional: false,
-          #                             type: String)
-        ]
-      end
-
-      def self.is_supported?(platform)
-        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
-        # See: https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Platforms.md
-        #
-        # [:ios, :mac, :android].include?(platform)
-        true
-      end
-    end
-  end
-end