tworingtools 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e283802686ddec482dfa738d63a288146317b151a23ac375f4e29dcfa68e5b
-  data.tar.gz: 4944611322f47b1435b638b7c39d0809f869b1d73cf718f9b9e7f92203b3baf8
+  metadata.gz: 92b3d2b2119f4550caa1bea34457c623f70f406947393765b46f60b7e55cb9ae
+  data.tar.gz: 6abbde855a4bb79818e6833b464724583cef15acfe1b80180953697dad420d99
 SHA512:
-  metadata.gz: da70cf856c13914d7d220f9bacf3829548dc2db82e4a6f464e243f8f8bbfcdca5d67fe33d3ad0ca9d28b859f88d8a4319bcfb0f6fc178c54c6d897888ade15d8
-  data.tar.gz: e2d273bcd615287e2fef46e172b91c403fb38e8ccca57ed9deedb66a19d5d6c2b4dcdb6e4df4b8a844b932e63c2111fb2e225d4bf18fb929e6f0cd4e9f164f20
+  metadata.gz: 8044bfc8f56b663876098c1b696f203112494917fde9c42ded6d2f9578f636d2bbb8f478c9f5683407659edf7fd30c27121a93162edf68d4ab48cb06e0b27dcf
+  data.tar.gz: b957e3e536cf096da7c1bd0ce70a0f48076c3491baaaa98a2322dbd99280254010fe811e17e482ebb3343967d9cd3d8b7162ccd8806ba76fb501e2f618bbe0f8

data/bin/changetag

@@ -0,0 +1,123 @@
+#! /usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/echoexec'
+
+# failure modes
+ILLEGAL_COMMENT_CHAR = 65
+INVALID_CHANGELOG_PATH = 66
+UNFORCED_ANNOTATION_OVERWRITE_ATTEMPT = 67
+CHANGELOG_ENTRY_NOT_FOUND = 68
+
+options = {}
+parser = OptionParser.new do |opts|
+  opts.banner = <<~BANNER
+
+    Usage: changetag [options] <changelog-path> <tag-name>
+
+           Write changes from changelogs into git tags.
+
+           For normal usage, provide the path to the changelog from which to extract release notes, and the git tag name for which you'd like to extract release notes. This pulls the relevant section from your changelog, as long as you adhere to the format described at http://keepachangelog.com/en/1.0.0/.
+
+           Note that the specification requires using the '#' character for hierarchical organization. Conveniently, this also renders different header styles with markdown. Unfortunately, that character is used to denote comments in git tag annotations (similar to git commit messages). So, before using changetag, you must change this to a different character: 
+
+                $> git config core.commentchar "@"
+
+           changetag looks for this configuration setting, and if it's set to ‘#’, will fail with a message instructing you to change it.
+
+           By default, changetag tries to extract the relevant section from your changelog using the name of the git tag you supply. If your changelog entries differ from your tag names, you can supply an override using the -n/--name option.
+
+    Examples:
+
+           Take the changelog entry for version 1.2.4 and write it into the tag annotation for tag ‘1.2.4’, creating the tag if it doesn't already exist, and overwriting it if it does:
+
+                $> changetag /path/to/.../CHANGELOG.md 1.2.4
+
+    Options:
+
+  BANNER
+  opts.on('-f', '--force', 'If a git tag already exists with a nonempty annotation message, overwrite the message. (If this is not supplied, changetag will quit with a warning that you are attempting to overwrite an existing tag annotation.)') do |force| options[:force] = true end
+  opts.on('-nNAME', '--name=NAME', 'By default, changetag tries to extract the relevant section from your changelog using the name of the git tag you supply. If your changelog entries differ from your tag names, you can supply an override using this option. Make sure that it includes all content contained withing the square brackes for the entry header.') do |name| options[:name] = name end
+end
+parser.parse!
+
+# check for a valid git message comment character
+
+comment_char = `git config --get core.commentchar`.strip
+if comment_char == '' or comment_char == '#' then
+  puts 'Your git comment character is still set to ‘#’. You need to change it to another character before using changetag. For instance:'
+  puts
+  puts "\tgit config core.commentchar '@'"
+  puts
+  exit ILLEGAL_COMMENT_CHAR
+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
+end
+
+git_tag = ARGV[1]
+current_git_tag_annotation = `git tag -n #{git_tag}`.strip
+git_tag_exists = current_git_tag_annotation != ''
+if git_tag_exists and current_git_tag_annotation != git_tag and options[:force] != true then
+  puts "The tag #{git_tag} already has an annotation. To overwrite it, call changetag with the -f/--force option."
+  exit UNFORCED_ANNOTATION_OVERWRITE_ATTEMPT
+end
+
+=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>
+
+## [<subsequent-entry-name>] <entry-date>
+
+<contents>
+
+... etc ...
+=end
+changelog_contents = File.open(changelog_path).readlines
+if options[:name] != nil then 
+  entry_name = options[:name]
+else 
+  entry_name = git_tag
+end
+
+entry_start_idx = -1
+changelog_contents.each_with_index do |line, i|
+  next if line[0..2] != '## '
+  if line.include?("[#{entry_name}]") then
+    entry_start_idx = i
+    break
+  end
+end
+
+if entry_start_idx == -1 then
+  puts "Could not find an entry in the changelog named '#{entry_name}'."
+  exit CHANGELOG_ENTRY_NOT_FOUND
+end
+
+entry_end_idx = -1
+changelog_contents.each_with_index do |line, i|
+  next if i <= entry_start_idx
+  if line[0..2] == '## ' then
+    entry_end_idx = i - 1
+    break
+  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")
+
+# 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
+  echo_and_exec "git tag #{git_tag} -m \"#{entry_contents}\""
+end

data/bin/sync-forks

@@ -5,6 +5,10 @@ require 'json'
 require 'optparse'
 require_relative '../lib/echoexec'
 
+# failure modes
+FURTHER_REQUESTS_REQUIRE_TOKEN = 65
+MISSING_REQUIRED_CREDENTIALS = 66
+
 options = {}
 parser = OptionParser.new do |opts|
   opts.banner = <<~BANNER
@@ -52,11 +56,11 @@ elsif nil != options[:username] && nil != options[:password]
   puts
   puts "\tsync-forks -u #{user} -t #{token.token}"
   puts
-  exit
+  exit FURTHER_REQUESTS_REQUIRE_TOKEN
 else
   puts "Must provide either a username/token or username/password/otp combination to authenticate."
   puts parser
-  exit
+  exit MISSING_REQUIRED_CREDENTIALS
 end
 
 repos = github.repos.list user: options[:username], auto_pagination: true
@@ -80,7 +84,7 @@ forks.each do |forked|
   else
     echo_and_exec "git clone #{url}"
     Dir.chdir "#{name}"
-    echo_and_exec "git remote add upstream #{fork_url} --mirror=fetch"
+    echo_and_exec "git remote add upstream #{fork_url}"
     Dir.chdir ".."
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tworingtools
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Andrew McKnight
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2018-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -41,13 +41,16 @@ dependencies:
 description: |2
     - rebuild-sims: Delete all simulators and recreate one for each compatible platform and device type pairing.
     - sync-forks: Make sure all your GitHub forks are clones into a given directory, and have “upstream” remotes pointing to the repos that were forked.
+    - changetag: Extract changelog entries to write into git tag annotation messages.
 email: andrew@tworingsoft.com
 executables:
 - rebuild-sims
 - sync-forks
+- changetag
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/changetag
 - bin/rebuild-sims
 - bin/sync-forks
 - lib/echoexec.rb