releasinator 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13f6f9c34a097f3dcb68bd15c8df1501f190a482
-  data.tar.gz: 6860c893ba8ddf2efe8d1011473afe3309f42e5f
+  metadata.gz: cfcb0c0860fd15ef1e4ece2155302b634699dcc2
+  data.tar.gz: 8aa056a5a1f092e7ac2fafb183b73061bce4e666
 SHA512:
-  metadata.gz: 91891918d99e27b46e1c88d0de701d3d90f312a356c9c910d5d04fda7260efdca1331ae2d1d096406a74e82f392160a6ffd11e127a1984bd614f42d37b6d567e
-  data.tar.gz: bc6aca918ee4cf5a4c5265f706f53a92c8a3910b315198ddfe8b973b8df654d1953b0dad2ab986dd9cfa8b1199be08f2eae436a645c6af2ecaa49f5e963aa36c
+  metadata.gz: 6e519b13c6301ede333d82afa4d2a3216cb785000802c1e1b7b3cecdd20f63183d4de46fc34bd4c980b20846555b6bd158f5e1b420d7130083d361c14f00965a
+  data.tar.gz: efb92b51475f46d51892ea3598af803827fea3555131fcff533ad2387efc6cd7455fa96c90541c199121f6fce103f6de68985f9b7f8a65f8a7f4606273c4f3a6

data/.gitignore

@@ -1 +1,2 @@
 build
+.DS_Store

data/.releasinator.rb

@@ -46,7 +46,7 @@ def build_method
   CommandProcessor.command("mv releasinator-*.gem #{output_dir}")
 end
 
-# The command that builds the sdk.  Required.
+# The command that builds the project.  Required.
 configatron.build_method = method(:build_method)
 
 def publish_to_package_manager(version)
@@ -56,7 +56,7 @@ def publish_to_package_manager(version)
   end
 end
 
-# The method that publishes the sdk to the package manager.  Required.
+# The method that publishes the project to the package manager.  Required.
 configatron.publish_to_package_manager_method = method(:publish_to_package_manager)
 
 

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Releasinator release notes
 ==========================
 
+0.5.0
+-----
+* The releasinator is now Open Source!
+* Validate `.gitignore` includes `.DS_Store`.
+
 0.4.1
 -----
 * `release_to_github` will now create a new release (instead of a draft).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    releasinator (0.4.1)
+    releasinator (0.5.0)
       colorize (~> 0.7)
       configatron (~> 4.5)
       json (~> 1.8)
@@ -23,13 +23,13 @@ GEM
     octokit (4.3.0)
       sawyer (~> 0.7.0, >= 0.5.3)
     power_assert (0.3.0)
-    rake (11.1.2)
+    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.1.8)
+    test-unit (3.2.0)
       power_assert
     vandamme (0.0.11)
       github-markup (~> 1.3)

data/README.md

@@ -4,7 +4,7 @@
 
 ## Problem
 
-When automating an SDK release process, many teams and languages have different ideas. 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 SDK.
+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.
 
 ## Solution
 
@@ -77,14 +77,14 @@ release
 
 ### Config
 
-A default config file is created when running any releasinator rake task for the first time.  This file includes placeholders for all the mandatory config items.  Below is the full list of config options.
+A [default config file](lib/default_config.rb) is created when running any releasinator rake task for the first time.  This file includes placeholders for all the mandatory config items.  Below is the full list of config options.
 
 #### Required `.releasinator.rb` config options:
 
-1. `configatron.product_name`: The name of the sdk for usage in various commit statements.
+1. `configatron.product_name`: The name of the project for usage in various commit statements.
 2. `configatron.prerelease_checklist_items`: List of items to confirm from the person releasing.
-3. `configatron.build_method`: The command that builds the sdk.
-4. `configatron.publish_to_package_manager_method`: The method that publishes the sdk to the package manager.
+3. `configatron.build_method`: The command that builds the project.
+4. `configatron.publish_to_package_manager_method`: The method that publishes the project to the package manager.
 5. `configatron.wait_for_package_manager_method`: The method that waits for the package manager to be done.
 6. `configatron.release_to_github`: True if publishing the root repo to GitHub.
 
@@ -98,6 +98,16 @@ A default config file is created when running any releasinator rake task for the
 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.
 
+#### Appending existing tasks in the releasinator lifecycle:
+
+In some cases, releasing a project may require a deviation from the task lifecycle. To deal with this without requiring an update to the releasinator, you may just append an existing task in your project's config file.  For example:
+
+```
+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
 

data/Rakefile

@@ -1 +1 @@
-import "./lib/tasks/releasinator.rake"
+import "./lib/tasks/releasinator.rake"

data/lib/command_processor.rb

@@ -56,4 +56,4 @@ module Releasinator
       Printer.success("Returned non-empty output.")
     end
   end
-end
+end

data/lib/config_hash.rb

@@ -56,4 +56,4 @@ module Releasinator
       '.'
     end
   end
-end
+end

data/lib/copy_file.rb

@@ -10,4 +10,4 @@ module Releasinator
       @target_dir.freeze
     end
   end
-end
+end

data/lib/current_release.rb

@@ -8,4 +8,4 @@ module Releasinator
       @changelog.freeze
     end
   end
-end
+end

data/lib/default_config.rb

@@ -11,14 +11,14 @@ def build_method
   abort("please implement build_method method")
 end
 
-# The command that builds the sdk.  Required.
+# The command that builds the project.  Required.
 configatron.build_method = method(:build_method)
 
 def publish_to_package_manager(version)
   abort("please implement publish_to_package_manager method")
 end
 
-# The method that publishes the sdk to the package manager.  Required.
+# The method that publishes the project to the package manager.  Required.
 configatron.publish_to_package_manager_method = method(:publish_to_package_manager)
 
 
@@ -30,4 +30,4 @@ configatron.wait_for_package_manager_method = method(:wait_for_package_manager)
 
 # True if publishing the root repo to GitHub.  Required.
 configatron.release_to_github = true
-)
+)

data/lib/downstream.rb

@@ -67,7 +67,7 @@ module Releasinator
                 # remove old everything
                 CommandProcessor.command("rm -rf *")
 
-                # update all sdk files
+                # update all distribution files
                 CommandProcessor.command("rsync -av --exclude='#{DOWNSTREAM_REPOS}' --exclude='.git/' #{copy_from_dir}/* .")
                 CommandProcessor.command("rsync -av --exclude='#{DOWNSTREAM_REPOS}' --exclude='.git/' #{copy_from_dir}/.[!.]* .")
               end

data/lib/downstream_repo.rb

@@ -28,4 +28,4 @@ module Releasinator
       false
     end
   end
-end
+end

data/lib/git_util.rb

@@ -124,4 +124,4 @@ module Releasinator
       end
     end
   end
-end
+end

data/lib/github_repo.rb

@@ -47,4 +47,4 @@ module Releasinator
       end 
     end
   end
-end
+end

data/lib/printer.rb

@@ -18,4 +18,4 @@ module Releasinator
       end
     end
   end
-end
+end

data/lib/publisher.rb

@@ -26,6 +26,18 @@ module Releasinator
       end
     end
 
+    def upload_asset(repo_url, release, path_or_file, content_type)
+      begin
+        github_repo = GitHubRepo.new(repo_url)
+        github_release = github_repo.client.release_for_tag "#{github_repo.org}/#{github_repo.repo}", release.version
+        github_repo.client.upload_asset github_release.url, path_or_file, :content_type => content_type
+      rescue => error
+        #This will fail if it cannot upload the files
+        Printer.fail(error.inspect)
+        abort()
+      end
+    end
+
     def publish_pull_request(repo_url, release, product_name, base, head)
       begin
         github_repo = GitHubRepo.new(repo_url)

data/lib/releasinator/version.rb

@@ -1,3 +1,3 @@
 module Releasinator
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/lib/tasks/releasinator.rake

@@ -87,6 +87,7 @@ namespace :validate do
   task :gitignore => :config do
     @validator.validate_exist('.', ".gitignore", DOWNSTREAM_REPOS)
     @validator.validate_exist(@releasinator_config.base_dir, ".gitignore", DOWNSTREAM_REPOS) if '.' != @releasinator_config.base_dir
+    @validator.validate_gitignore_contents(".DS_Store")
     if @releasinator_config.has_key?(:downstream_repos)
       @validator.validate_gitignore_contents("#{DOWNSTREAM_REPOS}/")
     end

data/lib/validator.rb

@@ -140,16 +140,13 @@ module Releasinator
       if !line_match_in_file?(line, ".gitignore")
         is_git_already_clean = GitUtil.is_clean_git?
         File.open('.gitignore', 'a') do |f|
-          f.puts "# #{@releasinator_config[:releasinator_name]}"
           f.puts line
         end
 
+        Printer.success("Added missing line '#{line}' to .gitignore.")
+
         if is_git_already_clean
-          CommandProcessor.command("git add . && git commit -m \"#{@releasinator_config[:releasinator_name]}: add downstream dir to .gitignore\"")
-          Printer.success("Added downstream dir to .gitignore file.")
-        else
-          Printer.fail("Added downstream dir to .gitignore file, but there are other changes in the workspace.  Please commit and continue.")
-          abort()
+          CommandProcessor.command("git add . && git commit -m \"#{@releasinator_config[:releasinator_name]}: add missing line to .gitignore\"")
         end
       end
     end

data/lib/validator_changelog.rb

@@ -98,4 +98,4 @@ module Releasinator
       CurrentRelease.new(latest_release, latest_release_changelog)
     end
   end
-end
+end

data/releasinator.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Releasinator::VERSION
   spec.authors       = ["PayPal"]
   spec.email         = ["DL-PP-RUBY-SDK@paypal.com"]
-  spec.summary       = %q{The releasinator assists in building and releasing SDKs across languages.}
-  spec.description   = %q{The releasinator assists in building and releasing SDKs across languages.}
+  spec.summary       = %q{The releasinator assists in building and releasing open source projects.}
+  spec.description   = %q{The releasinator assists in building and releasing open source projects.}
   spec.homepage      = "https://developer.paypal.com"
   spec.license       = "Apache-2.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: releasinator
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - PayPal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: The releasinator assists in building and releasing SDKs across languages.
+description: The releasinator assists in building and releasing open source projects.
 email:
 - DL-PP-RUBY-SDK@paypal.com
 executables: []
@@ -193,5 +193,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: The releasinator assists in building and releasing SDKs across languages.
+summary: The releasinator assists in building and releasing open source projects.
 test_files: []