tworingtools 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92b3d2b2119f4550caa1bea34457c623f70f406947393765b46f60b7e55cb9ae
-  data.tar.gz: 6abbde855a4bb79818e6833b464724583cef15acfe1b80180953697dad420d99
+  metadata.gz: 90a1bc7d807d2796539d05469cbfc08267d44cd893a8329ae9e4bb8136cfdde4
+  data.tar.gz: dcc34f89bcfb21cfa384ce6f47ea523187894fae6f115befff262a66ca189c0d
 SHA512:
-  metadata.gz: 8044bfc8f56b663876098c1b696f203112494917fde9c42ded6d2f9578f636d2bbb8f478c9f5683407659edf7fd30c27121a93162edf68d4ab48cb06e0b27dcf
-  data.tar.gz: b957e3e536cf096da7c1bd0ce70a0f48076c3491baaaa98a2322dbd99280254010fe811e17e482ebb3343967d9cd3d8b7162ccd8806ba76fb501e2f618bbe0f8
+  metadata.gz: fe5fc725dabcfc11dd59f8d74138610a25d5f417f6e8c891eb25682c6e86f02dc0fd9d5bfdcc6dbbe0ea6ec192775ec9c973b6835352ff2941d75df518fb21bc
+  data.tar.gz: f9ab4e4f9df84926094333840543b8aa5aa48eb14ae9cf4362edf7d2f2f955f9ebf211fdf6f16742cd4e32e868011783214f2436ecdf0a5512b5ddbc6aa5af5c

data/bin/changetag

@@ -55,7 +55,6 @@ end
 # get the changelog entry contents
 
 changelog_path = ARGV[0]
-
 unless File.file?(changelog_path) then
   puts "The path '#{changelog_path}' does not point to a valid file."
   exit INVALID_CHANGELOG_PATH
@@ -69,9 +68,8 @@ if git_tag_exists and current_git_tag_annotation != git_tag and options[:force]
   exit UNFORCED_ANNOTATION_OVERWRITE_ATTEMPT
 end
 
+# Extract the relevant section from the changelog, which should have the following format: (square brackets should be present, chevrons are to denote content descriptions)
 =begin
-Extract the relevant section from the changelog, which should have the following format: (square brackets should be present, chevrons are to denote content descriptions)
-
 ## [<entry-name>] <entry-date>
 
 <contents>
@@ -82,6 +80,7 @@ Extract the relevant section from the changelog, which should have the following
 
 ... etc ...
 =end
+
 changelog_contents = File.open(changelog_path).readlines
 if options[:name] != nil then 
   entry_name = options[:name]
@@ -112,10 +111,25 @@ changelog_contents.each_with_index do |line, i|
   end
 end
 
-entry_contents = changelog_contents[entry_start_idx..entry_end_idx].select{|x| x != "\n"}.join("\n").gsub('`', '\\\`').gsub("'", '\\\'').gsub('"', '\\\"').split("\n").join("\n")
+# get the changelog entry lines
+entry_contents = changelog_contents[entry_start_idx..entry_end_idx].select{|x| x != "\n"}
 
-# create or edit a git tag with the changelog contents
+# clean up the entry name by just setting it to the name of the tag
+entry_contents[0] = entry_name
+
+# combine the lines and escape any quotes that will mess with the command executed in shell
+entry_contents = entry_contents.join("\n").gsub('`', '\\\`').gsub("'", '\\\'').gsub('"', '\\\"').split("\n")
 
+# shorten any markdown headings. The entry name should be at level two ("##"), so remove two from each string of hashes that begins a line
+entry_contents.map! do |line|
+  line unless line[0] == '#'
+  line.gsub(/^\#\#/, '')
+end
+
+# join the final result into a string
+entry_contents = entry_contents.join("\n")
+
+# create or edit a git tag with the changelog contents
 if git_tag_exists then
   echo_and_exec "git tag #{git_tag} #{git_tag} -f -m \"#{entry_contents}\""
 else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tworingtools
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Andrew McKnight