fastlane-plugin-changelog 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: d04b08c8560041a91f3d0519d4bfc23911b0a42288557cf8aef9c97079f8fb1d
-  data.tar.gz: d63b349d8edb891f5aae14ad36f9a9b60a8d77b81cf7c9b8d333c6d273b2391b
+SHA1:
+  metadata.gz: 88dc3f6cc69c73c660b54513b941382eda0f8866
+  data.tar.gz: bc40d6fe17cebb7a3ae63ffac3a2fe1f8a9a9a12
 SHA512:
-  metadata.gz: 31e601796d7e22f23a49e4e8c2c2dbdb2fcde008d73f6876f217199cdc59e91c7a4c330f4a3617668de95ecad5920844b2edf035056a1ca7a77c7932b5c7a6cc
-  data.tar.gz: 327da23f6766f75963b8fa41bcf4e6d4c1ba5b3b7e1ae49d1127d26c1135fdd05b8216a2d7e5629b5f1bf73e1996ad4de73d0f2e26dc49a8f3aad860ed03d48e
+  metadata.gz: 691abf1f00864a292359498499cf6af7b1fb308373f268ba7ac440e04ef73016af2ccb575190fa5b7c294c549be53e4806790a97809778d233cd65814e166033
+  data.tar.gz: 5ee732505ba076fd8bff381ade7e0ff6041f78edad5cb9a2160aca477e1c2d241102b07029086e65c51fc611f09afdd5dc7e6ae35cede277195bca694583d745

data/README.md

@@ -14,7 +14,7 @@ fastlane add_plugin changelog
 
 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). 
 
 ## Actions
 `fastlane-plugin-changelog` consists of 3 actions enabling you to manipulate `CHANGELOG.md` from [`fastlane`](https://fastlane.tools).

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

@@ -57,7 +57,7 @@ module Fastlane
           end
         end
 
-        UI.success("Successfuly emojified output of read_changelog action")
+        UI.success("Successfully emojified output of read_changelog action")
 
         Actions.lane_context[SharedValues::EMOJIFY_CHANGELOG_CONTENT] = emojified_content
       end

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

@@ -14,20 +14,22 @@ module Fastlane
           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]
+          should_stamp_date = params[:should_stamp_date]
+          stamp_datetime_format = params[:stamp_datetime_format]
           git_tag = params[:git_tag]
           placeholder_line = params[:placeholder_line]
 
-          stamp(changelog_path, section_identifier, stamp_date, git_tag, placeholder_line)
+          stamp(changelog_path, section_identifier, should_stamp_date, stamp_datetime_format, git_tag, placeholder_line)
         end
       end
 
-      def self.stamp(changelog_path, section_identifier, stamp_date, git_tag, placeholder_line)
+      def self.stamp(changelog_path, section_identifier, should_stamp_date, stamp_datetime_format, 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,
+                                          should_append_date: should_stamp_date,
+                                          append_datetime_format: stamp_datetime_format,
                                           excluded_placeholder_line: placeholder_line)
 
         file_content = ""
@@ -101,7 +103,7 @@ module Fastlane
         changelog = File.open(changelog_path, "w")
         changelog.puts(file_content)
         changelog.close
-        UI.success("Successfuly stamped #{section_identifier} in #{changelog_path}")
+        UI.success("Successfully stamped #{section_identifier} in #{changelog_path}")
       end
 
       #####################################################
@@ -129,10 +131,17 @@ module Fastlane
                                        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: :stamp_date,
-                                       env_name: "FL_STAMP_CHANGELOG_SECTION_STAMP_DATE",
-                                       description: "Specifies whether the current date should be appended to section identifier",
+          FastlaneCore::ConfigItem.new(key: :should_stamp_date,
+                                       env_name: "FL_STAMP_CHANGELOG_SHOULD_STAMP_DATE",
+                                       description: "Specifies whether the current date as per the stamp_datetime_format should be stamped to the section identifier",
                                        default_value: true,
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :stamp_datetime_format,
+                                       env_name: "FL_STAMP_CHANGELOG_DATETIME_FORMAT",
+                                       description: "The strftime format string to use for the date in the stamped section",
+                                       default_value: '%FZ',
+                                       is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :git_tag,
                                        env_name: "FL_STAMP_CHANGELOG_GIT_TAG",

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

@@ -48,8 +48,14 @@ module Fastlane
               line_old = line.dup
               line.sub!(section_name, new_section_identifier)
 
-              if params[:append_date]
-                now = Time.now.strftime("%Y-%m-%d")
+              should_append_date = params[:should_append_date]
+
+              if should_append_date
+                append_datetime_format = params[:append_datetime_format]
+
+                now = Time.now.utc.strftime(append_datetime_format)
+                ENV["FL_UPDATE_APPEND_DATETIME_VAL"] = now
+
                 line.concat(" - " + now)
                 line.delete!(line_separator) # remove line break, because concatenation adds line break between section identifer & date
                 line.concat(line_separator) # add line break to the end of the string, in order to start next line on the next line
@@ -72,7 +78,7 @@ module Fastlane
         changelog = File.open(changelog_path, "w")
         changelog.puts(file_content)
         changelog.close
-        UI.success("Successfuly updated #{changelog_path}")
+        UI.success("Successfully updated #{changelog_path}")
       end
 
       def self.is_section_line(line)
@@ -114,12 +120,18 @@ module Fastlane
                                        description: "The updated unique section identifier (without square brackets)",
                                        is_string: true,
                                        optional: true),
-          FastlaneCore::ConfigItem.new(key: :append_date,
-                                       env_name: "FL_UPDATE_CHANGELOG_APPEND_DATE",
-                                       description: "Appends the current date in YYYY-MM-DD format after the section identifier",
+          FastlaneCore::ConfigItem.new(key: :should_append_date,
+                                       env_name: "FL_UPDATE_CHANGELOG_SHOULD_APPEND_DATE",
+                                       description: "Specifies whether the current date as per the append_datetime_format should be appended to section identifier",
                                        default_value: true,
                                        is_string: false,
                                        optional: true),
+          FastlaneCore::ConfigItem.new(key: :append_datetime_format,
+                                       env_name: "FL_UPDATE_CHANGELOG_APPEND_DATETIME_FORMAT",
+                                       description: "The strftime format string to use for the date after the section identifier",
+                                       default_value: '%FZ',
+                                       is_string: 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",

data/lib/fastlane/plugin/changelog/helper/changelog_helper.rb

@@ -65,7 +65,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
       # Writes given content to CHANGELOG.md in project root
       def self.write_to_changelog(changelog)
         File.open(CHANGELOG_PATH, 'w') { |f| f.write(changelog) }
-        FastlaneCore::UI.success('Successfuly created CHANGELOG.md')
+        FastlaneCore::UI.success('Successfully created CHANGELOG.md')
       end
 
       def self.get_line_separator(file_path)

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Changelog
-    VERSION = "0.15.0"
+    VERSION = "0.16.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-changelog
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Pavel Prochazka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-22 00:00:00.000000000 Z
+date: 2021-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Automate changes to your project CHANGELOG.md