releasinator 0.6.4 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c78ceb11194e8ecddadf40d89435327f707f334
-  data.tar.gz: a6c2516d0665a72ca1f853a6e0c4b8904408fffc
+  metadata.gz: ae6a23ab3be34c267540720c00929120c025ee98
+  data.tar.gz: 8a2dd6a07ea6d57d9921058a667e29e9dec14ece
 SHA512:
-  metadata.gz: 5c9b905b61fc83b79081e36c2630974a9c68642352b4d346a8b1d2d762aac922f6af844f83e63193dfd079567822e9596b9bfcff926e59fb5d8b5d0be3c40acb
-  data.tar.gz: 3b2959b1a4d07be4a9e160f74e95e9d9ec65a119df4904495d54de9efeb5c397e19bfbc20f57de3ebec23affde865b02e25d293ae4f1484444eb96a95c31a53d
+  metadata.gz: dc20169b9f864a5a41dd9907a286c212d7ab30fb1fbb0f39537f6d9be020a7f21f10b00b3ccb9be29cf3edf595d3d438ed47d2e90bee75a9a83f8f157b562cbc
+  data.tar.gz: 89a413e33460ae2f6c31dd85de46974ed0063353a876f7bbe66348517adab4c13fecb0f44f2f83fd706325ec8a196596ed764419bb1390232057ed251de6ca1f

data/.releasinator.rb

@@ -1,3 +1,5 @@
+require 'releasinator/version'
+
 configatron.product_name = "Releasinator"
 
 # List of items to confirm from the person releasing.  Required, but empty list is ok.
@@ -5,7 +7,6 @@ configatron.prerelease_checklist_items = [
 ]
 
 def validate_version_match()
-  require 'releasinator/version'
   spec_version = Releasinator::VERSION
   if spec_version != @current_release.version
     Printer.fail("Ruby gem spec version #{spec_version} does not match changelog version #{@current_release.version}.")
@@ -49,6 +50,17 @@ end
 # The command that builds the project.  Required.
 configatron.build_method = method(:build_method)
 
+def update_version_method(version, semver_type)
+  version_file = "lib/releasinator/version.rb"
+
+  text = File.read(version_file)
+  replace = text.gsub(Releasinator::VERSION, version)
+  File.open(version_file, "w") {|file| file.puts replace}
+end
+
+# The command that populates a new version to all relevant files.  Required.
+configatron.update_version_method = method(:update_version_method)
+
 def publish_to_package_manager(version)
   output_dir = "build"
   Dir.chdir(output_dir) do

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 Releasinator release notes
 ==========================
 
+0.7.0
+-----
+* Optionally update version and CHANGELOG.md inline.
+
 0.6.4
 -----
 * Remove unused 'fileutils' dependency.

data/README.md

@@ -100,6 +100,8 @@ A [default config file](lib/default_config.rb) is created when running any relea
 5. `configatron.doc_build_method`: The method that builds the docs.
 6. `configatron.doc_target_dir`: The directory where to run all git commands when publishing the docs.  If not specified, the default is `.`.  Generally useful if the docs are only applicable on a downstream release, rather than on the source itself.
 7. `configatron.doc_files_to_copy`: List of CopyFile objects for copying built docs into a targeted location.  Please see documentation on the `CopyFile` class.
+8. `configatron.update_version_method`: Takes a new version, and populates to all relevant files. Only called if not first release, and updating version in-flow (see below).
+9. `configatron.update_version_commit_message`: The commit message used after updating the CHANGELOG and version. Only used if not first release, and updating version in-flow (see below).
 
 #### Appending existing tasks in the releasinator lifecycle:
 
@@ -110,6 +112,7 @@ task :"validate:changelog" do
   puts "validating changelog complete, let's dance!".red
 end
 ```
+
 This will append the task `validate:changelog`, running the code block after the official releasinator task contents have run.  See [this blog post](http://www.dan-manges.com/blog/modifying-rake-tasks) for a detailed description of how this mechanism works.  You may append a task more than once.
 
 ## Conventions
@@ -125,6 +128,20 @@ The releasinator enforces certain conventions.  If a filename closely matches th
   3. Releases MUST not skip versions (such as `1.0.0 -> 1.0.2`, or `1.0.2 -> 1.1.1`).  That is, if you skip or botch a release, it MUST be documented as an official release with a minimal description suggesting that this release is not actually available, or was skipped. This is for the benefit future maintainers of the repo to know that certain releases were not actually published or are not to be used (for whatever reason). In addition, external developers benefit when they look to upgrade versions and want to know what changes were made since a particular release. They can rest at ease knowing that there are no unaccounted-for releases. 
 5. `.gitignore` and `.DS_store`: While this file is Mac-specific, many repos contain this entry in their `.gitignore` files because it is quite common for developers to have their global `.gitignore` configured incorrectly. Therefore, the authors of this project have made the decision to force this entry in all `.gitignore` files as a gesture of goodwill to all these new git users.
 
+## Inline updating of version and `CHANGELOG.md`
+
+For your first release, the releasinator expects that the `CHANGELOG.md` contains an initial entry and that the initial version is placed as appropriate in relevant files.
+
+For subsequent releases, the releasinator can handle updating the `CHANGELOG.md` and version numbers as part of the release flow. If you'd like to update your `CHANGELOG.md` and version manually, ensure that your release's `CHANGELOG.md` entry and version updates in any relevant files are pushed to your remote prior to releasing.
+
+The releasinator will ask during the release flow whether or not to update the `CHANGELOG.md` and versions. If so, it:
+
+1. Checks the `CHANGELOG.md` for the most recently released version.
+2. Prompts for the type of release (major, minor, or patch).
+3. Increments the version number accordingly, and passes it to `configatron.update_version_method`, for you to update relevant files.
+4. Opens an editor and prompts you to provide a `CHANGELOG.md` entry.
+5. Updates the `CHANGELOG.md` accordingly.
+
 ## Behind the Scenes
 
 #### Validations (in no particular order)

data/lib/changelog/updater.rb

@@ -0,0 +1,101 @@
+require 'tmpdir'
+
+require_relative '../command_processor'
+require_relative '../printer'
+require_relative '../git_util'
+
+module Releasinator
+  module Changelog
+    class Updater
+
+      def self.bump_version(version=GitUtil.tags.last)
+        loop do
+          term = Printer.ask("What type of release is this? (major, minor, patch)")
+
+          case term
+          when "major", "minor", "patch"
+            current_version = Semantic::Version.new(version).increment!(term.to_sym).to_s
+            yield(current_version, term)
+
+            return current_version
+          else
+            Printer.fail("release type must be one of: [major, minor, patch]")
+          end
+        end
+      end
+
+      def self.prompt_for_change_log(version, semver_type)
+        new_changes = Dir.mktmpdir do |dir|
+          tmp_cl = "#{dir}/tmp-changelog-release#{Time.now.to_i}.md"
+          last_version = GitUtil.tags.last
+          tmp_change_log = "\n\n# Please enter a bulleted CHANGELOG list summarizing the changes for #{semver_type} version #{version}."
+          tmp_change_log += "\n# Lines starting with '# ' will be ignored."
+          tmp_change_log += "\n#"
+          tmp_change_log += "\n# Changes since #{last_version}:"
+          tmp_change_log += "\n#"
+          tmp_change_log += "\n# "
+          tmp_change_log += GitUtil.commits(from_tag=last_version).reverse.join("\n# ")
+          tmp_change_log += "\n#"
+          tmp_change_log += "\n"
+          File.foreach("CHANGELOG.md") do |line|
+            tmp_change_log += "# #{line}"
+          end
+          File.open(tmp_cl, "w") {|file| file.puts tmp_change_log }
+
+          editor = ENV["EDITOR"]
+          if editor == nil
+            Printer.fail("Value of $EDITOR environment variable must be set in order to edit CHANGELOG")
+            abort()
+          elsif "" == CommandProcessor.command("which #{editor} | cat")
+            Printer.fail("Value of $EDITOR (#{editor}) not found on path")
+            abort()
+          end
+
+          system("$EDITOR #{tmp_cl}")
+
+          new_changes = ""
+          File.foreach(tmp_cl) do |line|
+            if !line.start_with?("# ") && !line.start_with?("#\n")
+              new_changes += line
+            end
+          end
+
+          new_changes
+        end
+
+        self.update_changelog(new_changes, version)
+      end
+
+      private
+      def self.update_changelog(new_changes, version)
+        changelog = "CHANGELOG.md"
+
+        in_header = true
+        header = ""
+        old_changes = ""
+        File.open(changelog, "r") do |file|
+          file.each_line do |line|
+            if in_header
+              in_header = !/\d+\.\d+\.\d+$/.match(line)
+            end
+
+            if in_header
+              header += line
+            else
+              old_changes += line
+            end
+          end
+        end
+
+        h2 = old_changes.start_with? "##"
+        if h2
+          new_changes = "## #{version}\n" + new_changes
+        else
+          new_changes = "#{version}\n-----\n" + new_changes
+        end
+
+        File.open(changelog, "w") {|file| file.puts(header + new_changes.chomp + "\n" + old_changes.chomp) }
+      end
+    end
+  end
+end

data/lib/default_config.rb

@@ -14,6 +14,18 @@ end
 # The command that builds the project.  Required.
 configatron.build_method = method(:build_method)
 
+def update_version_method(version, semver_type)
+  # semver_regex = /^version = "\d+.\d+.\d+"$/
+  # contents = File.read("setup.py")
+  # contents = contents.gsub(semver_regex, "version = \"\#{version}\"")
+  # File.open("setup.py", "w") do |f|
+  #   f << contents
+  # end
+end
+
+# The command that populates a new version to all relevant files.  Recommended.
+# configatron.update_version_method = method(:update_version_method)
+
 def publish_to_package_manager(version)
   abort("please implement publish_to_package_manager method")
 end

data/lib/git_util.rb

@@ -1,4 +1,5 @@
 require_relative 'command_processor'
+require 'semantic'
 
 module Releasinator
   class GitUtil
@@ -152,5 +153,52 @@ module Releasinator
         end
       end
     end
+
+    def self.tags(remote=false)
+      if remote
+        CommandProcessor.command("git ls-remote --tags").split("\n")
+          .map { |tag| tag.split()[1].strip.gsub("refs/tags/", "") }
+          .keep_if { |tag| !tag.include? "{}" }
+      else
+        CommandProcessor.command("git tag --list").split("\n")
+      end
+    end
+
+    def self.tagged_versions(remote=false)
+      version_reg = Semantic::Version::SemVerRegexp
+      tags = self.tags(remote)
+
+      tags.map { |tag|
+        if tag.start_with? "v"
+          tag = tag[1..tag.size]
+        end
+
+        if tag =~ version_reg
+          tag
+        end
+      }.compact
+    end
+
+    def self.stage(files=".")
+      CommandProcessor.command("git add #{files}")
+    end
+
+    def self.commit(message)
+      CommandProcessor.command("git commit -m'#{message}'")
+    end
+
+    def self.reset_head(hard=false)
+      CommandProcessor.command("git reset#{' --hard' if hard} HEAD")
+    end
+
+    def self.commits(from_tag=nil, to_tag="HEAD")
+      rev = ""
+      if from_tag
+        rev = "#{from_tag}..#{to_tag}"
+      end
+
+      # Format: [short hash] [date] [commit message] ([author])
+      CommandProcessor.command("git log #{rev} --pretty=format:'%h %ad%x20%s%x20%x28%an%x29' --date=short").split("\n").reverse!
+    end
   end
 end

data/lib/printer.rb

@@ -17,5 +17,25 @@ module Releasinator
         abort()
       end
     end
+
+    def self.ask(msg)
+      puts msg.yellow
+      $stdin.gets.chomp.downcase
+    end
+
+    def self.ask_binary(msg)
+      answer = self.ask("#{msg} (Y/n)")
+
+      while answer != "y" && answer != "n" do
+        puts "Please answer y or n".red
+        answer = self.ask("#{msg} (Y/n)")
+      end
+
+      return answer == "y"
+    end
+
+    def self.comment(msg)
+      puts msg.yellow
+    end
   end
 end

data/lib/releasinator/version.rb

@@ -1,3 +1,3 @@
 module Releasinator
-  VERSION = "0.6.4"
+  VERSION = "0.7.0"
 end

data/lib/tasks/releasinator.rake

@@ -11,7 +11,8 @@ require_relative '../downstream'
 require_relative '../downstream_repo'
 require_relative '../publisher'
 require_relative '../validator'
-require_relative '../changelog/importer.rb'
+require_relative '../changelog/importer'
+require_relative '../changelog/updater'
 
 include Releasinator
 
@@ -28,7 +29,7 @@ end
 
 namespace :validate do
   desc "validate the presence, formatting, and semver sequence of CHANGELOG.md"
-  task :changelog => :config do
+  task :changelog => [:config, :git] do
     @current_release = @validator.validate_changelog(DOWNSTREAM_REPOS)
     @current_release.freeze
     @downstream = Downstream.new(@releasinator_config, @validator, @current_release)
@@ -150,9 +151,63 @@ namespace :validate do
   end
 end
 
+desc "Update release version and CHANGELOG"
+task :update_version_and_changelog do
+  begin
+    Changelog::Updater.bump_version do |version, semver_type|
+      @releasinator_config[:update_version_method].call(version, semver_type)
+      Changelog::Updater.prompt_for_change_log(version, semver_type)
+
+      GitUtil.stage
+      if @releasinator_config.has_key? :update_version_commit_message
+        GitUtil.commit(@releasinator_config[:update_version_commit_message])
+      else
+        GitUtil.commit("Update version and CHANGELOG.md for #{version}")
+      end
+    end
+  rescue Exception => e
+    GitUtil.reset_head(true)
+    Printer.fail("Failed to update version: #{e}")
+    abort()
+  end
+end
+
 desc "release all"
-task :release => [:"validate:all",:"local:build",:"pm:all",:"downstream:all",:"local:push",:"docs:all"] do
-  Printer.success("Done releasing.")
+task :release => [:"validate:all"] do
+  last_tag = GitUtil.tagged_versions(true).last
+
+  if !last_tag.nil? # If last tag is nil, at this point, there must be changelog entry, but this is the first releasinator release, proceed.
+    last_tag = Semantic::Version.new(last_tag)
+    commits_since_tag = GitUtil.commits(last_tag)
+    if commits_since_tag.size > 0 # There are new commits to be released
+      if @current_release.version > last_tag # CHANGELOG.md version is ahead of last tag. The releaser has already updated the changelog, and we've valdidated it
+        if !Printer.ask_binary("The version from CHANGELOG.md '#{@current_release.version}' is greater than the last tagged version '#{last_tag}'. Have you already updated your version and CHANGELOG.md?")
+          Printer.fail("Update your version and CHANGELOG.md and re-run rake release.")
+          abort()
+        end
+      elsif @releasinator_config.has_key? :update_version_method
+        if Printer.ask_binary("It doesn't look like your CHANGELOG.md has been updated. HEAD is #{commits_since_tag.size} commits ahead of tag #{last_tag}. Do you want to update CHANGELOG.md and version now?")
+          Rake::Task[:update_version_and_changelog].invoke
+          Rake::Task[:"validate:changelog"].reenable
+          Rake::Task[:"validate:changelog"].invoke
+        else
+          Printer.fail("Update your version and CHANGELOG.md and re-run rake release.")
+          abort()
+        end
+      else
+        Printer.fail("It doesn't look like your CHANGELOG.md has been updated. HEAD is #{commits_since_tag.size} commits ahead of last tagged version '#{last_tag}'. Please update CHANGELOG.md or implement update_version_method in .releasinator.rb to allow releasinator to perform this step on your behalf. See https://github.com/paypal/releasinator for more details.")
+        abort()
+      end
+    elsif !Printer.ask_binary("There are no new commits since last tagged version '#{last_tag}'. Are you sure you want to release?")
+      abort()
+    end
+  end
+
+  [:"local:build",:"pm:all",:"downstream:all",:"local:push",:"docs:all"].each do |task|
+    Rake::Task[task].invoke
+  end
+
+  Printer.success("Done releasing #{@current_release.version}")
 end
 
 namespace :import do
@@ -348,9 +403,8 @@ namespace :docs do
 end
 
 def replace_string(filepath, string_to_replace, new_string)
-  IO.write(filepath,
-    File.open(filepath) do |file|
-      file.read.gsub(string_to_replace, new_string)
-    end
-  )
+  text = File.read(filepath)
+  new_contents = text.gsub(string_to_replace, new_string)
+
+  File.open(filepath, "w") {|file| file.puts new_contents }
 end

data/releasinator.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 11.1"
   spec.add_development_dependency "test-unit", "~> 3.1"
+  spec.add_development_dependency "mocha", "~> 1.3.0"
 
   spec.add_dependency "configatron", "~> 4.5"
   spec.add_dependency "colorize", "~> 0.7"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: releasinator
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.0
 platform: ruby
 authors:
 - PayPal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: configatron
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +167,7 @@ files:
 - README.md
 - Rakefile
 - lib/changelog/importer.rb
+- lib/changelog/updater.rb
 - lib/changelog/validator.rb
 - lib/command_processor.rb
 - lib/config_hash.rb