fastlane-plugin-changelog 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b3f23e18421455b7d1d85d01f42ad3417021681
-  data.tar.gz: ef0b316111c36cc87147d033378960f40282ee5a
+  metadata.gz: 8942aab0857114d3400eaa42bebba390d2a231c0
+  data.tar.gz: 4d46daef140989c1159640ec6a6a25eb1b7b6b85
 SHA512:
-  metadata.gz: eec2930f9df64e9cc1dd80247568650d81185363922f4d48ad5dae45bfeeaef79434b3f01866ac55e77c4f9a269570fb90c45ce8ae1584e1e3d097bddcf8bb63
-  data.tar.gz: 287e063b596c7cc2b0a18e92397d770f92ac7fc4bdc4a0860be8f6b261e6e0ee49212418e9a55ff562eb0c7f1fb6db7a7a4ddf6fc1ed8a7884c77f3650374d99
+  metadata.gz: bfa381bc7b38b0b71e8179be0ae1a4123e7b9f552cb752b3b207e176d5a367cc622166bcf7c480b2bac5ef26a1d8999335341164849b31240b62fd74014da364
+  data.tar.gz: aa4431cabe2585de78c49a5164529780791cd25377e726b0003b386e07b890b8379d9178aa4a6eb7f0890b08eada155aa1dfe00931dc03993ba57c28dba49921

data/README.md

@@ -1,6 +1,6 @@
 # changelog plugin
 
-[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-changelog)
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-changelog)[![Build Status](https://travis-ci.org/pajapro/fastlane-plugin-changelog.svg?branch=master)](https://travis-ci.org/pajapro/fastlane-plugin-changelog)  [![Twitter: @hello_paja](https://img.shields.io/badge/contact-@Hello_Paja-blue.svg?style=flat)](https://twitter.com/hello_paja)
 
 ## Getting Started
 
@@ -16,14 +16,6 @@ This plugin is inspired by and based on [Keep a CHANGELOG](http://keepachangelog
 
 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 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).
 
@@ -49,8 +41,8 @@ read_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
+  section_identifier: '[Build 123]', # Specify what section to update
+  updated_section_identifier: 'Build 321' # Specify new section identifier
 )
 ```
  
@@ -59,8 +51,8 @@ Stamps the _Unreleased_ (see [How can I minimize the effort required?](http://ke
 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 
-  git_tag: "bXYZ" # Specify reference to git tag associated with this section
+  section_identifier: 'Build XYZ', # Specify identifier to stamp the Unreleased section with 
+  git_tag: 'bXYZ' # Specify reference to git tag associated with this section
 )
 ```
 

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

@@ -8,7 +8,7 @@ module Fastlane
       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]
 
@@ -46,16 +46,14 @@ module Fastlane
       def self.remove_markdown(line, excluded_markdown_elements)
         markdownless_line = line
         excluded_markdown_elements.each do |element|
-          if line =~ /^#{element}/
-            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
-            
+          next unless line =~ /^#{element}/
+          index_of_element = line.index(element)
+          index_of_whitespace = index_of_element + element.to_s.length
+
+          if line[index_of_whitespace] == " " # 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
 

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

@@ -12,11 +12,11 @@ module Fastlane
         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 
+        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

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

@@ -4,13 +4,12 @@ module Fastlane
       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
@@ -32,12 +31,10 @@ module Fastlane
               if params[:append_date]
                 now = Time.now.strftime("%Y-%m-%d")
                 line.concat(" - " + now)
-                line.delete!("\n")  # remove line break, because concatenation adds line break between section identifer & date
+                line.delete!("\n") # remove line break, because concatenation adds line break between section identifer & date
                 line.concat("\n") # add line break to the end of the string, in order to start next line on the next line
               end
 
-              found_identifying_section = false
-              
               UI.message "Old section identifier: #{line_old.delete!("\n")}"
               UI.message "New section identifier: #{line.delete("\n")}"
 

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

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

data/lib/fastlane/plugin/changelog.rb

@@ -2,10 +2,55 @@ require 'fastlane/plugin/changelog/version'
 
 module Fastlane
   module Changelog
+    CHANGELOG_PATH = './CHANGELOG.md'
+    DEFAULT_CHANGELOG = '# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+### Added
+- Your awesome new feature'
+
     # Return all .rb files inside the "actions" and "helper" directory
     def self.all_classes
       Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
     end
+
+    # Offer user to setup CHANGELOG.md file in project folder (unless it already exists)
+    def self.setup_changelog
+      unless has_changelog?
+        if FastlaneCore::UI.confirm('Your project folder does not have CHANGELOG.md - do you want to create one now?')
+          create_changelog
+
+          FastlaneCore::UI.message('Changelog plugin can automaticaly create a link for comparison between two tags (see https://github.com/pajapro/fastlane-plugin-changelog#--stamp_changelog)')
+          if FastlaneCore::UI.confirm('Do you want to create links for comparing tags on Github?')
+            github_url = FastlaneCore::UI.input('Enter your Github URL (e.g.: https://github.com/fastlane/fastlane):')
+            output = DEFAULT_CHANGELOG + "\n\n[Unreleased]: #{github_url}/compare/master...HEAD"
+            write_to_changelog(output)
+          else
+            write_to_changelog(DEFAULT_CHANGELOG)
+          end
+        end
+      end
+    end
+
+    # Does CHANGELOG.md exists in project folder?
+    def self.has_changelog?
+      File.exist?(CHANGELOG_PATH)
+    end
+
+    # Create CHANGELOG.md file
+    def self.create_changelog
+      FileUtils.touch 'CHANGELOG.md'
+    end
+
+    # Write given content to CHANGELOG.md
+    def self.write_to_changelog(changelog)
+      File.open(CHANGELOG_PATH, 'w') { |f| f.write(changelog) }
+      FastlaneCore::UI.success('Successfuly created CHANGELOG.md')
+    end
   end
 end
 
@@ -14,3 +59,6 @@ end
 Fastlane::Changelog.all_classes.each do |current|
   require current
 end
+
+# By default we want to ensure CHANGELOG.md is present
+Fastlane::Changelog.setup_changelog

metadata

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