releasinator 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c50b2ca2d8e7f05c2cfdcfb7e6277e88dbe9566
-  data.tar.gz: bff4e52e4c64da30a0100041af927320366b2263
+  metadata.gz: ab62a0c97b76f7949927089ed8756d227bc562da
+  data.tar.gz: 984e1bab0a50be8123d97bf5c0f65de91864786d
 SHA512:
-  metadata.gz: e59589a4510ae9d20c6c484c852b3d43968ff90c9eae075942ed7d11da245fce889f78208382ac649a6304cd76f74bddb9d62eb7eb4021fa312b2773d66dbd95
-  data.tar.gz: c7e3f660cf30e2d6d5db862a87dfe46f8027b40befd2a51869c8f1d1b4dcb8ecd694659b7425e9a1168999bd78c4b06873b0453a881bc3bcfa08542fa1646c28
+  metadata.gz: e5e7bc23e4894f7decf65be066cb1abc3e9932ed01bd7423563a39e56000a029e763cec8c676a058c3d6b4229f15f1fa80042fc5bb398eeebac5bf4b27e4471f
+  data.tar.gz: 43e238ce42076e9ec99225d15654532a48ef1653c369176d5fd466162e0cf956ddc959eac178b0c602a75f5b7ae9106bf48e0fcc9f8cf6a4c52048fc4d0598f3

data/.gitignore

@@ -1,2 +1,4 @@
 build
 .DS_Store
+
+Gemfile.lock

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Releasinator release notes
 ==========================
 
+0.6.3
+-----
+* When using git flow, validate the release branch is an ancestor of the develop branch.  User must confirm a warning if is not.
+* Update some error messages.
+
 0.6.2
 -----
 * Re-enable bullet punctuation detection, now handling multi-line comments correctly!

data/README.md

@@ -4,7 +4,7 @@
 
 ## Problem
 
-When automating a release process for libraries, SDKs, apps, or other open source projects, many teams have different ideas.  This is on top of the fact that each language has its own conventions and repositories for distributing packages.  The release process is a hurdle that makes it hard for new project members to ramp up.  One shouldn't have to read a `release_process.md` to release an open source project.
+When automating a release process for libraries, SDKs, apps, or other open source projects, many teams have different ideas.  This is on top of the fact that each language has its own conventions and repositories for distributing packages.  The release process is a hurdle that makes it hard for new project members to ramp up.  One should not have to read a `release_process.md` to release an open source project.
 
 ## Solution
 
@@ -110,7 +110,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.
+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
 
@@ -122,7 +122,8 @@ The releasinator enforces certain conventions.  If a filename closely matches th
 4. `CHANGELOG.md` - This file is the source of truth for the releasinator.  The file should be organized with the most recent release on top, and formatted correctly.  The latest release is the one used when the releasinator executes, so it is a precondition that the `CHANGELOG.md` has been edited and committed **prior to releasing**.
   1. Releases either are contained within an Alt-H2 (`------`) or `##H2` format.  Any other format will be rejected.
   2. Each release MUST start with the release version, and may contain any following text, such as the date, and/or any release summary.
-5. `.gitignore` and `.DS_store`: While this file is Mac-specific, many repos contain this entry in their `.gitignore` files because it's quite common for developers to not have their global `.gitignore` configured correctly. Therefore, the authors of this project have made the decision to force this entry in all `.gitignores`, as a gesture of goodwill to all these new git users.
+  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.
 
 ## Behind the Scenes
 
@@ -182,7 +183,7 @@ The releasinator enforces certain conventions.  If a filename closely matches th
 9. ✓ Push to external repo (once live in external package manager).
 10. ✓ Create PRs into any downstream dependencies, including the release notes in the PR.  Examples:
     
-    * Create a PR into Cordova when there's an Android or iOS release.
+    * Create a PR into Cordova when there is an Android or iOS release.
     * Create a PR into any other framework that has a direct dependency on this repo.
 
 11. Using the downstream methods, one can add those same release notes within the release notes of the downstream repo.

data/lib/changelog/validator.rb

@@ -86,7 +86,7 @@ module Releasinator
         end
         
         if changelog_hash.empty?
-          Printer.fail("Unable to find any releases in the CHANGELOG.md.  Please check that your formatting is correct.")
+          Printer.fail("Unable to find any releases in the CHANGELOG.md.  Please check that the formatting is correct.")
           abort()
         end
         
@@ -110,8 +110,7 @@ module Releasinator
 
           if starts_with_bullet? line
             if previous_line_in_progress
-              Printer.fail("'#{previous_line_in_progress}' is invalid.  Bulleted points should end in punctuation.")
-              abort()
+              fail_punctuation(previous_line_in_progress)
             elsif ends_with_punctuation? line
               # self-contained line is a-ok, and the usual use-case
               previous_line_in_progress = nil
@@ -135,8 +134,8 @@ module Releasinator
 
         # the last line may not be clean.  Handle it.
         if previous_line_in_progress
-          Printer.fail("'#{previous_line_in_progress}' is invalid.  Bulleted points should end in punctuation.")
-          abort()
+          fail_punctuation(previous_line_in_progress)
+
         end
       end
 
@@ -147,6 +146,11 @@ module Releasinator
       def ends_with_punctuation?(line)
         line.match /.*[\!,\?:\.]$/
       end
+
+      def fail_punctuation(line)
+        Printer.fail("'#{line}' is invalid.  Bulleted points should end in punctuation and no trailing line whitespace.")
+        abort()
+      end
     end
   end
 end

data/lib/git_util.rb

@@ -121,6 +121,10 @@ module Releasinator
       output
     end
 
+    def self.is_ancestor?(root_branch, child_branch)
+      "0" == CommandProcessor.command("git merge-base --is-ancestor #{root_branch} #{child_branch}; echo $?").strip
+    end
+
     def self.tag(new_tag, changelog)
       confirm_tag_overwrite(new_tag)
       puts "tagging with changelog: \n\n#{changelog}\n".yellow

data/lib/releasinator/version.rb

@@ -1,3 +1,3 @@
 module Releasinator
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

data/lib/validator.rb

@@ -359,6 +359,14 @@ module Releasinator
           abort()
         end
 
+        # validate that develop is an ancestor of release branch.  Warn if not, but allow user to proceed, as this may be desired for maintenance releases.
+        if current_branch == expected_release_branch
+          root_branch = "develop"
+          if !GitUtil.is_ancestor?(root_branch, current_branch)
+            Printer.check_proceed("#{current_branch} is missing commits from #{root_branch}.  Are you sure you want to continue?", "Please rebase #{current_branch} to include the latest from #{root_branch}.")
+          end
+        end
+
         # validate that master is up to date, because git flow requires this.
         validate_local_matches_remote("master")
       else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: releasinator
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - PayPal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2016-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,7 +149,6 @@ files:
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -169,7 +168,6 @@ files:
 - lib/releasinator/version.rb
 - lib/tasks/releasinator.rake
 - lib/validator.rb
-- lib/validator_changelog.rb
 - releasinator.gemspec
 homepage: https://developer.paypal.com
 licenses:

data/Gemfile.lock

@@ -1,48 +0,0 @@
-PATH
-  remote: .
-  specs:
-    releasinator (0.6.2)
-      colorize (~> 0.7)
-      configatron (~> 4.5)
-      json (~> 1.8)
-      octokit (~> 4.0)
-      semantic (~> 1.4)
-      vandamme (~> 0.0.11)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.4.0)
-    colorize (0.8.1)
-    configatron (4.5.0)
-    faraday (0.9.2)
-      multipart-post (>= 1.2, < 3)
-    github-markup (1.4.0)
-    json (1.8.3)
-    multipart-post (2.0.0)
-    octokit (4.3.0)
-      sawyer (~> 0.7.0, >= 0.5.3)
-    power_assert (0.3.0)
-    rake (11.2.2)
-    redcarpet (3.3.4)
-    sawyer (0.7.0)
-      addressable (>= 2.3.5, < 2.5)
-      faraday (~> 0.8, < 0.10)
-    semantic (1.4.1)
-    test-unit (3.2.0)
-      power_assert
-    vandamme (0.0.11)
-      github-markup (~> 1.3)
-      redcarpet (~> 3.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.11)
-  rake (~> 11.1)
-  releasinator!
-  test-unit (~> 3.1)
-
-BUNDLED WITH
-   1.12.5

data/lib/validator_changelog.rb

@@ -1 +0,0 @@
-