fastlane-plugin-write_changelog_from_commits 0.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73e69f7387e4b8d41ea6eb23607fd00bef32236c59d7953124357ccaa97f0424
-  data.tar.gz: abe9aa127f6cc3db8c92133a928157fae94c0fb3fa1f986dc8d487da50f4369e
+  metadata.gz: 5707d97c28c877e78013eb1b8e5bf6757e064f6bf5d77e326a8abb1f052ed4a6
+  data.tar.gz: 24ca778219cfd443a9ae03fcfd28fd82e62f97787899c2a1ad453121635b5691
 SHA512:
-  metadata.gz: 76e90f86ac0dc15d1097fec33486994fde5aa3fcae55dc4d8a331fb638ede1059d984ec7b703b0919c697699fc094456465cf636beb19320e50fcf54611d6c52
-  data.tar.gz: 032fd1577b7ee7b1872f264a484e323b6d5a1efe7d810faa644266b2dfcec42fb9d18d0492acc128759d1cc75ccd98a46b15bffa77bfc1da060db05893784b51
+  metadata.gz: 10517b260337dc51802a33db747bcd9edcceecf79528b049ef6ec96843ade82c2e12c92690739b17cd4d1cb0cdc9c4054f89950f00c51605e2feeec2df6663d1
+  data.tar.gz: 243b911308f277f9292ee14ed08d3728aee6b160768f2370d4c55ee7e1d6ea33135824860a131bb4f5ead13d3ac156e3a23913924470d10a2ca678a04a97ef62

data/lib/fastlane/plugin/write_changelog_from_commits/actions/write_changelog_from_commits_action.rb

@@ -1,19 +1,21 @@
-require 'fastlane/action'
-require_relative '../helper/write_changelog_from_commits_helper'
+require "fastlane/action"
+require_relative "../helper/write_changelog_from_commits_helper"
 
 module Fastlane
   module Actions
     class WriteChangelogFromCommitsAction < Action
-      OTHER_SECTION = "Other"
-
       def self.run(params)
+        if params[:additional_section_name].nil? && params[:commit_prefixes].nil?
+          raise "Please provide either 'additional_section_name' or 'commit_prefixes' to action"
+        end
+
         from = Actions.last_git_tag_name
         UI.verbose("Found the last Git tag: #{from}")
-        to = 'HEAD'
+        to = "HEAD"
 
         if params[:path].nil?
           UI.message("No path provided, using default at '/'")
-          params[:path] = './' unless params[:path]
+          params[:path] = "./" unless params[:path]
         end
 
         params[:commit_prefixes] ||= []
@@ -23,7 +25,7 @@ module Fastlane
           changelog = changelog.gsub("\n\n", "\n") if changelog # as there are duplicate newlines
           raise "No logs found since last tag" if changelog.strip.empty?
 
-          raw_release_notes = create_raw_release_notes(changelog, params[:commit_prefixes])
+          raw_release_notes = create_raw_release_notes(changelog, params[:commit_prefixes], params[:additional_section_name])
 
           release_notes = create_release_notes(raw_release_notes)
           Actions.lane_context[SharedValues::FL_CHANGELOG] = release_notes
@@ -32,7 +34,7 @@ module Fastlane
           end
 
           if params[:version_code]
-            write_release_notes(release_notes, params[:version_code], params[:changelog_dir])
+            write_release_notes(release_notes, params[:version_code], params[:changelog_dir]) unless params[:read_only]
           else
             UI.message("No version code provided, so could not write file")
           end
@@ -40,19 +42,21 @@ module Fastlane
         end
       end
 
-      def self.create_raw_release_notes(changelog, commit_prefixes)
+      def self.create_raw_release_notes(changelog, commit_prefixes, additional_section_name)
         raw_release_notes = commit_prefixes.to_h { |p| [p.capitalize, []] }
-        raw_release_notes[OTHER_SECTION] = []
+        raw_release_notes[additional_section_name.capitalize] = [] if additional_section_name
         changelog.each_line do |line|
           section_exists = false
           commit_prefixes.each do |prefix|
             next unless line.downcase.start_with?(prefix.downcase)
 
-            raw_release_notes[prefix.capitalize] << line.slice(prefix.length..line.length).strip
+            raw_release_notes[prefix.capitalize] << line.slice(prefix.length..line.length).strip.capitalize
             section_exists = true
             break
           end
-          raw_release_notes[OTHER_SECTION] << line.strip unless section_exists
+          if additional_section_name && !section_exists
+            raw_release_notes[additional_section_name.capitalize] << line.strip.capitalize
+          end
         end
         raw_release_notes
       end
@@ -95,38 +99,52 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(
             key: :path,
-            env_name: 'write_changelog_from_commits_PATH',
-            description: 'Path of the git repository',
+            env_name: "WRITE_CHANGELOG_FROM_COMMITS_PATH",
+            description: "Path of the git repository",
             optional: true,
-            default_value: './'
+            default_value: "./",
           ),
           FastlaneCore::ConfigItem.new(
             key: :quiet,
-            env_name: 'write_changelog_from_commits_TAG_QUIET',
-            description: 'Whether or not to disable changelog output',
+            env_name: "WRITE_CHANGELOG_FROM_COMMITS_TAG_QUIET",
+            description: "Whether or not to disable changelog output",
             optional: true,
             default_value: false,
-            is_string: false
+            is_string: false,
           ),
           FastlaneCore::ConfigItem.new(
             key: :changelog_dir,
-            env_name: 'write_changelog_from_commits_CHANGELOG_DIR',
-            description: 'Path to write new changelogs',
-            optional: false
+            env_name: "WRITE_CHANGELOG_FROM_COMMITS_CHANGELOG_DIR",
+            description: "Path to write new changelogs",
+            optional: false,
           ),
           FastlaneCore::ConfigItem.new(
             key: :commit_prefixes,
-            env_name: "write_changelog_from_commits_PREFIXES",
-            description: "List of prefixes to group in the changelog",
+            env_name: "WRITE_CHANGELOG_FROM_COMMITS_PREFIXES",
+            description: "List of prefixes to group in the changelog (omit to place all lines under additional_section_name)",
             type: Array,
-            optional: true
+            optional: true,
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :additional_section_name,
+            env_name: "WRITE_CHANGELOG_FROM_COMMITS_ADDITIONAL_SECTION",
+            description: "Section to contain all other commit lines (omit if you only want to log lines beginning with prefixes)",
+            optional: true,
           ),
           FastlaneCore::ConfigItem.new(
             key: :version_code,
-            env_name: "write_changelog_from_commits_VERSION_CODE",
+            env_name: "WRITE_CHANGELOG_FROM_COMMITS_VERSION_CODE",
             description: "Version code used to create file",
-            optional: true
-          )
+            optional: true,
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :read_only,
+            env_name: "WRITE_CHANGELOG_FROM_COMMITS_READ_ONLY",
+            description: "If true will simply return the changelog rather than writing it",
+            optional: true,
+            default_value: false,
+            is_string: false,
+          ),
         ]
       end
 

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

@@ -1,5 +1,5 @@
 module Fastlane
   module WriteChangelogFromCommits
-    VERSION = "0.1.0"
+    VERSION = "3.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-write_changelog_from_commits
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Lewis Bright
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -84,16 +84,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-require_tools
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +156,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.168.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.168.0
+        version: '0'
 description:
 email: lewis_bright@yahoo.com
 executables: []