dpl 1.8.44.travis.2325.5 → 1.8.44.travis.2397.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f7cff9e81dff80016aac87332d1c20991399f54af1554d720e9e2bf4aefe387
-  data.tar.gz: 85af69affd470b423030588a70d11323d418d6a3bf4895528c0648044670cb59
+  metadata.gz: 96db389ba15f857fcd34a3d50ddf2f481c1d3f89f52a3c4fce9a225ae22f3842
+  data.tar.gz: 3d988dcf5742808aab0d971fb55709ed9dab143a228634c51f92b4f2485fb8f5
 SHA512:
-  metadata.gz: 46fbb974965a7e6183e3df68ea4fc4acf8f75b4d132b9d9ab20fd592fdaa93a4a4952b818af0f39a7f16361fa6ce5c44738bf3bcc2f7e8ee3c174ca2009ac4fa
-  data.tar.gz: cbea057d24c87a1fa2d445180d7d407c678fb580397464feaeaf0af83901f545fdc1d7295121a8011f2654d9e7c2d34d6f5b9ee8cf024e73867b9fccbfe0ac55
+  metadata.gz: a08487a04ed053ab383786f5f7d0be67e583e48b1ad8baf8e0143641687f2ba17407fb670e911dcc191a4212deb47e8838e44614ec22e6eb56d440e9234dd36c
+  data.tar.gz: 3b64e60e39dfd7485bb1c0a70a235d832d5d764d3abfa3a6aec76dedb889ca869bc234708b66a5ea3a9a291441df3ddda303c7a0f61d47f4e25e182fa5050a80

data/README.md

@@ -519,11 +519,15 @@ You first need to create an [Atlas account](https://atlas.hashicorp.com/account/
 * **github-token**: GitHub oauth token with `repo` permission.
 * **repo**: Repo slug, defaults to current one.
 * **target-branch**: Branch to push force to, defaults to gh-pages.
+* **keep-history**: Optional, create incremental commit instead of doing push force, defaults to false.
+* **allow-empty-commit**: Optional, defaults to false. Enabled if only keep-history is true.
+* **committer-from-gh**: Optional, defaults to false. Allows to use token's owner name and email for commit. Overrides `email` and `name` options.
+* **verbose**: Optional, be verbose about internal steps, defaults to false.
 * **local-dir**: Directory to push to GitHub Pages, defaults to current.
 * **fqdn**: Optional, no default, sets a main domain for your website.
 * **project-name**: Defaults to fqdn or repo slug, used for metadata.
-* **email**: Optional, comitter info, defaults to deploy@travis-ci.org.
-* **name**: Optional, comitter, defaults to Deployment Bot.
+* **email**: Optional, committer info, defaults to deploy@travis-ci.org.
+* **name**: Optional, committer, defaults to Deployment Bot.
 
 #### Examples:
 

data/lib/dpl/provider/pages.rb

@@ -8,6 +8,10 @@ module DPL
         - github-token [required]
         - github-url [optional, defaults to github.com]
         - target-branch [optional, defaults to gh-pages]
+        - keep-history [optional, defaults to false]
+        - allow-empty-commit [optional, defaults to false]
+        - committer-from-gh [optional, defaults to false]
+        - verbose [optional, defaults to false]
         - local-dir [optional, defaults to `pwd`]
         - fqdn [optional]
         - project-name [optional, defaults to fqdn or repo slug]
@@ -17,23 +21,38 @@ module DPL
 
       require 'tmpdir'
 
+      if RUBY_VERSION >= "2.0.0"
+        requires 'octokit', version: '~> 4.6.2'
+      else
+        requires 'octokit', version: '~> 4.3.0'
+      end
+
       experimental 'GitHub Pages'
 
       def initialize(context, options)
         super
 
-        @build_dir = options[:local_dir] || '.'
+        @build_dir = File.join(Dir.pwd, options[:local_dir] || '.')
         @project_name = options[:project_name] || fqdn || slug
         @target_branch = options[:target_branch] || 'gh-pages'
 
         @gh_fqdn = fqdn
         @gh_url = options[:github_url] || 'github.com'
         @gh_token = option(:github_token)
+        @keep_history = !!keep_history
+        @allow_empty_commit = !!allow_empty_commit
+        @committer_from_gh = !!committer_from_gh
+        @verbose = !!verbose
 
         @gh_email = options[:email] || 'deploy@travis-ci.org'
         @gh_name = "#{options[:name] || 'Deployment Bot'} (from Travis CI)"
 
         @gh_ref = "#{@gh_url}/#{slug}.git"
+        @gh_remote_url = "https://#{@gh_token}@#{@gh_ref}"
+        @git_push_opts = @keep_history ? '' : ' --force'
+        @git_commit_opts = (@allow_empty_commit and @keep_history) ? ' --allow-empty' : ''
+
+        print_step "The repo is configured to use committer user and email." if @committer_from_gh
       end
 
       def fqdn
@@ -44,34 +63,134 @@ module DPL
         options.fetch(:repo) { context.env['TRAVIS_REPO_SLUG'] }
       end
 
+      def keep_history
+        options.fetch(:keep_history, false)
+      end
+
+      def committer_from_gh
+        options.fetch(:committer_from_gh, false)
+      end
+
+      def allow_empty_commit
+        options.fetch(:allow_empty_commit, false)
+      end
+
+      def verbose
+        # Achtung! Never verbosify git, since it may expose user's token.
+        options.fetch(:verbose, false)
+      end
+
+      def api  # Borrowed from Releases provider
+        error 'gh-token must be provided for Pages provider to work.' unless @gh_token
+
+        @api ||= Octokit::Client.new(:access_token => @gh_token)
+      end
+
+      def user
+        @user ||= api.user
+      end
+
+      def setup_auth
+        user.login
+      end
+
       def check_auth
+        setup_auth
+
+        unless api.scopes.include? 'public_repo' or api.scopes.include? 'repo'
+          error "Dpl does not have permission to access #{@gh_url} using it. Make sure your token contains the repo or public_repo scope."
+        end
+
+        log "Logged in as @#{user.login} (#{user.name})"
+      rescue Octokit::Unauthorized => exc
+        error "gh-token is invalid. Details: #{exc}"
       end
 
       def needs_key?
         false
       end
 
-      def github_deploy
-        context.shell 'rm -rf .git > /dev/null 2>&1'
-        context.shell "touch \"deployed at `date` by #{@gh_name}\""
-        context.shell 'git init' or raise 'Could not create new git repo'
-        context.shell "git config user.email '#{@gh_email}'"
-        context.shell "git config user.name '#{@gh_name}'"
+      def print_step(msg)
+        log msg if @verbose
+      end
+
+      def github_pull_or_init(target_dir)
+        unless @keep_history
+          github_init(target_dir)
+          return
+        end
+
+        print_step "Trying to clone a single branch #{@target_branch} from existing repo..."
+        unless context.shell "git clone --quiet --branch='#{@target_branch}' --depth=1 '#{@gh_remote_url}' '#{target_dir}' > /dev/null 2>&1"
+          # if such branch doesn't exist at remote, init it from scratch
+          print_step "Cloning #{@target_branch} branch failed"
+          Dir.mkdir(target_dir)  # Restore dir destroyed by failed `git clone`
+          github_init(target_dir)
+        end
+      end
+
+      def github_init(target_dir)
+        FileUtils.cd(target_dir, :verbose => true) do
+          print_step "Creating a brand new local repo from scratch in dir #{Dir.pwd}..."
+          context.shell "git init" or raise 'Could not create new git repo'
+          print_step 'Repo created successfully'
+          context.shell "git checkout --orphan '#{@target_branch}'" or raise 'Could not create an orphan git branch'
+          print_step "An orphan branch #{@target_branch} created successfully"
+        end
+      end
+
+      def identify_preferred_committer
+        if @committer_from_gh and @gh_token
+          return (user.name or @gh_name), (user.email or @gh_email)
+        end
+        return @gh_name, @gh_email
+      end
+
+      def github_configure
+        committer_name, committer_email = identify_preferred_committer
+        print_step "Configuring git committer to be #{committer_name} <#{committer_email}> (workdir: #{Dir.pwd})"
+        context.shell "git config user.email '#{committer_email}'"
+        context.shell "git config user.name '#{committer_name}'"
+      end
+
+      def github_commit
+        committer_name, _ = identify_preferred_committer
+        print_step "Preparing to deploy #{@target_branch} branch to gh-pages (workdir: #{Dir.pwd})"
+        context.shell "touch \"deployed at `date` by #{committer_name}\""
         context.shell "echo '#{@gh_fqdn}' > CNAME" if @gh_fqdn
-        context.shell 'git add .'
-        context.shell "FILES=\"`git commit -m 'Deploy #{@project_name} to #{@gh_ref}:#{@target_branch}' | tail`\"; echo \"$FILES\"; echo \"$FILES\" | [ `wc -l` -lt 10 ] || echo '...'"
-        context.shell "git push --force --quiet 'https://#{@gh_token}@#{@gh_ref}' master:#{@target_branch} > /dev/null 2>&1"
+        context.shell 'git add -A .'
+        context.shell "git commit#{@git_commit_opts} -qm 'Deploy #{@project_name} to #{@gh_ref}:#{@target_branch}'"
+        context.shell 'git show --stat-count=10 HEAD'
+      end
+
+      def github_deploy
+        print_step "Doing the git push (workdir: #{Dir.pwd})..."
+        unless context.shell "git push#{@git_push_opts} --quiet '#{@gh_remote_url}' '#{@target_branch}':'#{@target_branch}' > /dev/null 2>&1"
+          error "Couldn't push the build to #{@gh_ref}:#{@target_branch}"
+        end
       end
 
       def push_app
-        Dir.mktmpdir {|tmpdir|
-            FileUtils.cp_r("#{@build_dir}/.", tmpdir)
-            FileUtils.cd(tmpdir, :verbose => true) do
-              unless github_deploy
-                error "Couldn't push the build to #{@gh_ref}:#{@target_branch}"
-              end
+        print_step "Starting deployment of #{@target_branch} branch to GitHub Pages..."
+        print_step "The deployment is configured to preserve the target branch if it exists on remote" if @keep_history
+        Dir.mktmpdir do |tmpdir|
+            workdir = "#{tmpdir}/work"
+            Dir.mkdir(workdir)
+            print_step "Created a temporary work directory #{workdir}"
+
+            github_pull_or_init(workdir)
+
+            FileUtils.cd(workdir, :verbose => true) do
+              print_step "Copying #{@build_dir} contents to #{workdir} (workdir: #{Dir.pwd})..."
+              context.shell "rsync -r --exclude .git --delete '#{@build_dir}/' '#{workdir}'" or error "Could not copy #{@build_dir}."
+
+              github_configure
+              github_commit
+              github_deploy
+              context.shell "git status" if @verbose
             end
-        }
+        end
+        print_step "App has been pushed"
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dpl
 version: !ruby/object:Gem::Version
-  version: 1.8.44.travis.2325.5
+  version: 1.8.44.travis.2397.5
 platform: ruby
 authors:
 - Konstantin Haase
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-13 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -230,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.2
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: deploy tool