releasinator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 194855b8293cef00a51d7cf0db1d92ffc40b8431
+  data.tar.gz: 3a83dfbf189daeed8dd226c6b58618d946d10a6b
+SHA512:
+  metadata.gz: cb334694d56c8b3152eb861d57b6861b8a7605a1ee2278916589b334f577b5abc8e8e1bc154632b25dd5abda40223c8c048add31764545b3a0526315eaed288e
+  data.tar.gz: 3e0c022e3146461f65cf51642a094606cf572c0e371543f8e3d9ad20bfb6e5b154739bfc9de08f915343beed4571a9745b04ce25db1005236acf9a81474f2642

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in releasinator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    releasinator (0.1.0)
+      colorize
+      configatron
+      json
+      octokit (~> 4.0)
+      semantic
+      vandamme
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    colorize (0.7.7)
+    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)
+    rake (11.1.2)
+    redcarpet (3.3.4)
+    sawyer (0.7.0)
+      addressable (>= 2.3.5, < 2.5)
+      faraday (~> 0.8, < 0.10)
+    semantic (1.4.1)
+    vandamme (0.0.11)
+      github-markup (~> 1.3)
+      redcarpet (~> 3.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  rake (~> 11.1)
+  releasinator!
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,114 @@
+# Releasinator
+
+## 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.
+
+## Solution
+
+The releasinator corrects this by enforcing standard must-have release files, being configurable where necessary, and reducing the ramp-up hurdle.
+
+## Making it work
+
+### Install
+
+1. Clone this repo
+2. Run `bundle install` from terminal. It should download dependencies.
+
+### Setup
+
+1. Set the environment variable `GITHUB_TOKEN` with a [generated personal access token](https://github.com/settings/tokens) with `repo` scope.
+
+### Usage
+
+1. `cd` to directory of the repo you'd like to release
+2. Run `rake -t -f <path to releasinator>/Rakefile`
+
+## Conventions
+
+The releasinator enforces certain conventions.  If a filename doesn't exactly match the convention, it is renamed to match, and automatically committed.  The conventions are documented below:
+
+1. `README.md`
+2. `LICENSE`: See [here](http://stackoverflow.com/questions/5678462/should-i-provide-a-license-txt-or-copying-txt-file-in-my-project) for a relevant StackOverflow post on this discussion.  This project has chosen to exclude the `.txt` extension to match other popular projects, and GitHub defaults.
+3. `CONTRIBUTING.md`: See [a relevant GitHub blog post](https://github.com/blog/1184-contributing-guidelines) for relevant information.  This project has chosen to include the `.md` extension, as these files can get a bit unwieldy without formatting.
+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.
+
+## Behind the Scenes
+
+#### Validations
+
+1. ✓ Validate git version.
+1. ✓ Validate git's cleanliness (no untracked, unstaged, or uncommitted files).
+1. ✓ Validate current git branch is up to date with the latest version on server.
+1. ✓ Validate current git branch is `master` (if no git flow), or `develop` or `release/<Release number>` if using git flow.
+1. ✓ Validate the presence of`.gitignore`, adding it if needed, and adding any needed lines.
+1. ✓ Validate the presence of the `README.md` file.
+1. ✓ Validate the presence of the `CHANGELOG.md` file.
+1. ✓ Validate the `CHANGELOG.md` file is properly formatted.
+1. ✓ Validate semver release number sequence in `CHANGELOG.md`.  (Note: cannot detect duplicate versions, due to the underlying Hash implementation of the parsing library.)
+1. ✓ Validate the presence of `LICENSE`.
+1. ✓ Validate the presence of `CONTRIBUTING.md`.
+1. ✓ Validate the presence of `.github/ISSUE_TEMPLATE.md`.
+1. ✓ Validate `LICENSE` and `CONTRIBUTING.md` are referenced in `README.md`.
+1. ✓ Validate all submodules are up to date with the latest master version.
+1. ✓ Validate all files are committed to git (`git ls-files --others --exclude-standard`).
+1. ✓ Validate user has valid access_tokens as environment variables for all repos (public & enterprise).  Public github requires `GITHUB_TOKEN`, while enterprise tokens add a modified version of their domain as a prefix.  For example, github.example.com requires `GITHUB_EXAMPLE_COM_GITHUB_TOKEN`.
+1. ✓ Validate user has permissions to push to repo, and downstream repos. 
+1. ✓ Validate anything as defined by the configuration.  Examples:
+    * Compiling with the right version of the platform.
+    * Upstream library dependencies are the latest available.
+
+#### Package manager credential management
+1. Validate permissions to publish to package manager
+2. If permissions are needed, retrieve them from the secret credential repo, and run any subsequent repo steps.
+
+#### Performs internal-only tasks:
+
+1. ✓ Confirm user has completed all manual tasks (aka pre-release checklist).
+1. ✓ Confirm overwrite of local tags already matching version.
+1. ✓ Create local tag.
+1. ✓ Run build command, as specified in the config file.
+
+#### Performs external-facing tasks:
+
+1. ✓ Clone/reset any downstream external distribution repos.
+2. ✓ Copy to destination repo:
+
+    * `README.md`
+    * `CHANGELOG.md`
+    * `LICENSE`
+    * `CONTRIBUTING.md`
+    * `.github/ISSUE_TEMPLATE.md`
+    * Any other distribution files.  This will be configured.
+
+3. ✓ Modify any dependency/versions in `README.md`, source, or sample apps to the latest version.  The location and regex of these will be configured.
+4. ✓ Build code and/or Sample apps.
+    * TODO If build fails, pause build and give developer a chance to fix the downstream build and retry without completely starting over.
+
+5. ✓ Push to appropriate package manager (nexus/cocoapods/composer/npm/nuget/rubygem/pypi).
+6. ✓ Confirm overwrite of remote tags already matching version.
+7. ✓ Create root and downstream repo tag and GitHub release.  The name of the release is the tag, and the annotated description and GitHub release is the relevant section of the `CHANGELOG.md`.
+8. ✓ Create downstream GitHub branch.
+9. ✓ Correctly handle git flow branches and merging.
+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 Braintree when mSDK/OTC release.
+    * Create a PR into Cordova when mSDK release.
+    * Create a PR into any other framework that has a direct dependency on this repo.
+
+11. TODO add those same release notes within the release notes of the downstream repo.  
+11. Assemble a draft of news, and publish (where possible, i.e. send email, tweet, whatever).
+
+#### Open items:
+
+* Might need a different name - [releasinator is taken](https://qconnewyork.com/ny2015/system/files/presentation-slides/QCon%20Distributing%20a%20Mobile%20Team.pdf) 
+
+### Example build files
+
+* https://github.paypal.com/SDK-R/PayPal-Android-SDK/blob/develop/fabfile.py
+* https://github.paypal.com/SDK-R/PayPal-iOS-SDK/blob/develop/fabfile.py
+* https://github.braintreeps.com/braintree/braintree-android/blob/master/Rakefile
+

data/Rakefile

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

data/lib/command_processor.rb

@@ -0,0 +1,55 @@
+require 'colorize'
+require_relative 'printer'
+
+module Releasinator
+  class CommandProcessor
+    def self.command(command, live_output=false)
+      puts Time.now.utc.iso8601 + ": " + "#{Dir.pwd}".bold + " exec:" + " #{command}".bold
+      if live_output 
+        puts "...with live output (forked process)".bold
+
+        return_code = nil
+        r, io = IO.pipe
+        pid = fork do
+          return_code = system(command, :out => io, :err => io)
+          if !return_code
+            Printer.fail("Execution failure.")
+            abort()
+          end
+        end
+        io.close
+        r.each_line{|l| puts l.strip.white}
+
+        Process.wait(pid)
+        fork_exitstatus = $?.exitstatus
+        if 0 != fork_exitstatus
+          Printer.fail("Forked process failed with exitstatus:#{fork_exitstatus}")
+          abort()
+        end
+      else
+        output = `#{command}`
+        exitstatus = $?.exitstatus
+        if 0 != exitstatus
+          Printer.fail("Process failed with exitstatus:#{exitstatus}")
+          abort()
+        end
+
+        output
+      end
+    end
+
+    # waits for the input command to return non-empty output.
+    def self.wait_for(command_to_execute, wait_for_seconds=30)
+      while "" == CommandProcessor.command(command_to_execute)
+        puts "Returned empty output.  Sleeping #{wait_for_seconds} seconds."
+        wait_for_seconds.times do
+          print "."
+          sleep 1
+        end
+        puts
+      end
+
+      Printer.success("Returned non-empty output.")
+    end
+  end
+end

data/lib/config_hash.rb

@@ -0,0 +1,44 @@
+require 'configatron'
+require_relative 'default_config'
+require_relative 'command_processor'
+require_relative 'git_util'
+
+RELEASINATOR_NAME = "releasinator"
+CONFIG_FILE_NAME = ".#{RELEASINATOR_NAME}.rb"
+
+module Releasinator
+  class ConfigHash < Hash
+    def initialize(verbose, trace)
+      update({:releasinator_name => RELEASINATOR_NAME})
+      update({:verbose => verbose})
+      update({:trace => trace})
+
+      require_file_name = "./.#{RELEASINATOR_NAME}.rb"
+      begin 
+        require require_file_name
+      rescue LoadError
+        is_git_already_clean = GitUtil.is_clean_git?
+        puts "It looks like this is your first time using #{RELEASINATOR_NAME} on this project.".yellow
+        puts "A default '#{CONFIG_FILE_NAME}' file has been created for you.".yellow
+        out_file = File.new("#{CONFIG_FILE_NAME}", "w")
+        out_file.write(DEFAULT_CONFIG)
+        out_file.close
+        require require_file_name
+        
+        # dpn't want to commit other files
+        if is_git_already_clean
+          puts "adding default #{CONFIG_FILE_NAME} to git".yellow
+          CommandProcessor.command("git add #{CONFIG_FILE_NAME}")
+          CommandProcessor.command("git commit -m \"#{RELEASINATOR_NAME}: add default config\"")
+        end
+      end
+
+      configatron.lock!
+      loaded_config_hash = configatron.to_h
+
+      update(loaded_config_hash)
+
+      puts "loaded config:" + self.to_s if verbose
+    end
+  end
+end

data/lib/copy_file.rb

@@ -0,0 +1,10 @@
+module Releasinator
+  class CopyFile
+    attr_reader :source_file, :target_name, :target_dir
+    def initialize(source_file, target_name, target_dir)
+      @source_file = source_file
+      @target_name = target_name
+      @target_dir = target_dir
+    end
+  end
+end

data/lib/current_release.rb

@@ -0,0 +1,9 @@
+module Releasinator
+  class CurrentRelease
+    attr_reader :release, :changelog
+    def initialize(release, changelog)
+      @release = release
+      @changelog = changelog
+    end
+  end
+end

data/lib/default_config.rb

@@ -0,0 +1,34 @@
+DEFAULT_CONFIG = %(configatron.product_name = "test product"
+
+# List of items to confirm from the person releasing.  Required, but empty list is ok.
+configatron.prerelease_checklist_items = [
+]
+
+# The directory where all distributed docs are.  Default is '.'
+# configatron.base_docs_dir = '.'
+
+def build_method
+  CommandProcessor.command("ls -al")
+end
+
+# The command that builds the sdk.  Required.
+configatron.build_method = method(:build_method)
+
+def publish_to_package_manager(version)
+  sleep 1
+  puts "done publishing yay!"
+end
+
+# The method that publishes the sdk to the package manager.  Required.
+configatron.publish_to_package_manager_method = method(:publish_to_package_manager)
+
+
+def wait_for_package_manager(version)
+end
+
+# The method that waits for the package manager to be done.  Required
+configatron.wait_for_package_manager_method = method(:wait_for_package_manager)
+
+# Whether to publish the root repo to GitHub.  Required.
+configatron.release_to_github = true
+)

data/lib/downstream_repo.rb

@@ -0,0 +1,18 @@
+module Releasinator
+  class DownstreamRepo
+    attr_reader :name, :url, :branch, :options
+    def initialize(name, url, branch, options={})
+      @name = name
+      @url = url
+      @branch = branch
+      @options = options
+      # options are:
+      #  :new_branch_name (if set, ignores :release_to_github)
+      #  :release_to_github
+      #  :files_to_copy
+      #  :full_file_sync
+      #  :post_copy_methods
+      #  :build_methods
+    end
+  end
+end

data/lib/git_util.rb

@@ -0,0 +1,67 @@
+require_relative 'command_processor'
+
+module Releasinator
+  class GitUtil
+    def self.is_clean_git?
+      any_changes = CommandProcessor.command("git status --porcelain")
+      '' == any_changes
+    end
+
+    def self.get_current_branch
+      CommandProcessor.command("git symbolic-ref --short HEAD").strip
+    end
+
+    def self.untracked_files
+      CommandProcessor.command("git ls-files --others --exclude-standard")
+    end
+
+    def self.diff
+      CommandProcessor.command("git diff")
+    end
+
+    def self.cached
+      CommandProcessor.command("git diff --cached")
+    end
+
+    def self.repo_url
+      CommandProcessor.command("git config --get remote.origin.url").strip
+    end
+
+    def self.delete_branch(branch_name)
+      if has_branch? branch_name
+        CommandProcessor.command("git branch -D #{branch_name}")
+      end
+    end
+
+    def self.has_branch?(branch_name)
+      "" != CommandProcessor.command("git branch --list #{branch_name}").strip
+    end
+
+    def self.has_remote_branch?(branch_name)
+      "" != CommandProcessor.command("git branch --list -r #{branch_name}").strip
+    end
+
+    def self.checkout(branch_name)
+      if get_current_branch != branch_name
+        CommandProcessor.command("git checkout #{branch_name}")
+      end
+    end
+
+    def self.init_gh_pages
+      if !has_branch? "gh-pages"
+        if has_remote_branch? "origin/gh-pages"
+          checkout("gh-pages")
+        else
+          CommandProcessor.command("git checkout --orphan gh-pages")
+          CommandProcessor.command("GLOBIGNORE='.git' git rm -rf *")
+          #http://stackoverflow.com/questions/19363795/git-rm-doesnt-remove-all-files-in-one-go
+          CommandProcessor.command("GLOBIGNORE='.git' git rm -rf *")
+          CommandProcessor.command("touch README.md")
+          CommandProcessor.command("git add .")
+          CommandProcessor.command("git commit -am \"Initial gh-pages commit\"")
+          CommandProcessor.command("git push -u origin gh-pages")
+        end
+      end
+    end
+  end
+end

data/lib/github_repo.rb

@@ -0,0 +1,45 @@
+require 'colorize'
+require 'octokit'
+require_relative 'printer'
+
+module Releasinator
+  class GitHubRepo
+    attr_reader :url, :org, :repo, :domain, :client
+
+    def initialize(url)
+      @url = url
+      if url.start_with?("https")
+        # https: "https://github.com/braebot/test.git"
+        slash_split = url.split("/")
+        @domain = slash_split[2]
+        @repo = slash_split.last.split(".git").first
+        slash_split.pop
+        @org = slash_split.last
+      else
+        # ssh: git@github.com:braebot/test.git"
+        colon_split = url.split(":")
+        at_split = colon_split.first.split("@")
+        @domain = at_split.last
+        slash_split = colon_split.last.split("/")
+        @org = slash_split.first
+        @repo = slash_split.last.split(".git").first
+      end
+
+      if @domain == "github.com"
+        check_token("GITHUB_TOKEN")
+        @client = Octokit::Client.new(:access_token => ENV["GITHUB_TOKEN"])
+      else
+        env_key = "#{@domain.gsub(".", "_").upcase}_GITHUB_TOKEN"
+        check_token(env_key)
+        @client = Octokit::Client.new(:access_token => ENV[env_key], :api_endpoint => "https://#{@domain}/api/v3/")
+      end
+    end
+
+    def check_token(token_param)
+      if !ENV[token_param]
+        Printer.fail("#{token_param} environment variable required.  Please set this to your personal access token.")
+        abort()
+      end 
+    end
+  end
+end

data/lib/printer.rb

@@ -0,0 +1,21 @@
+require_relative 'command_processor'
+
+module Releasinator
+  class Printer
+    def self.success(msg)
+      puts "\xE2\x9C\x94\xEF\xB8\x8E ".light_green + "SUCCESS: #{msg}".green
+    end
+
+    def self.fail(msg)
+      puts "\xE2\x9C\x98 FAILURE: #{msg}".red
+    end
+
+    def self.check_proceed(warning_msg, abort_msg)
+      puts "#{warning_msg}  Continue?  (Y/n)".yellow
+      if 'n' == STDIN.gets.strip
+        self.fail(abort_msg)
+        abort()
+      end
+    end
+  end
+end

data/lib/publisher.rb

@@ -0,0 +1,47 @@
+require 'octokit'
+require 'colorize'
+require_relative 'github_repo'
+require_relative 'printer'
+
+module Releasinator
+  class Publisher
+    def initialize(config)
+      @config = config
+    end
+
+    def publish_draft(repo_url, release)
+      github_repo = GitHubRepo.new(repo_url)
+
+      begin
+        # https://github.com/octokit/octokit.rb/blob/master/spec/octokit/client/releases_spec.rb#L18
+        github_release = github_repo.client.create_release "#{github_repo.org}/#{github_repo.repo}",
+          release.release,
+          :name => release.release,
+          :body => release.changelog,
+          :draft => true,
+          :prerelease => false
+        puts github_release.inspect if @config[:trace]
+      rescue => error
+        #This will fail if the user does not have push permissions.
+        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)
+        github_pull_request = github_repo.client.create_pull_request "#{github_repo.org}/#{github_repo.repo}",
+          base,
+          head,
+          "Update #{product_name} to #{release.release}",
+          release.changelog
+        puts github_pull_request.inspect if @config[:trace]
+      rescue => error
+        #This will fail if there's already a pull request
+        Printer.fail(error.inspect)
+        abort()
+      end
+    end
+  end
+end

data/lib/releasinator/version.rb

@@ -0,0 +1,3 @@
+module Releasinator
+  VERSION = "0.1.0"
+end