dpl-pages 1.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c761870ed3d3d724095f4fd8173f4f92bb7a188
+  data.tar.gz: 5c8a3b0f3019e6fc97a97ea9222a4600a9d2a5f2
+SHA512:
+  metadata.gz: ddf0dc3063439589750af489561202548d79f3923e14ad74569601b31e7e45447d08bc3b2c73ba9f7c7ea4dd31e6c4234385ad00a849d0c5b683dbd4cd2a0ff7
+  data.tar.gz: cad35745db487a095b8728c5bc8c0fdff300eeffc596f6834fb505aeff5bad374ddfa16cbb26c01f3cb27377c41ab65ff32f1a718ebe273ee70b07ace8bd7d10

data/dpl-pages.gemspec

@@ -0,0 +1,3 @@
+require './gemspec_helper'
+
+gemspec_for 'pages', [['octokit', '~> 4.6.2']]

data/lib/dpl/provider/pages.rb

@@ -0,0 +1,213 @@
+require 'octokit'
+
+module DPL
+  class Provider
+    class Pages < Provider
+      """Implements Github Pages deployment
+
+      Options:
+        - repo [optional, for pushed to other repos]
+        - 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]
+        - email [optional, defaults to deploy@travis-ci.org]
+        - name [optional, defaults to Deployment Bot]
+        - deployment-file [optional, defaults to false]
+      """
+
+      require 'tmpdir'
+      experimental 'GitHub Pages'
+
+      def initialize(context, options)
+        super
+
+        @build_dir = File.join(src_dir, options[:local_dir] || '.')
+        print_step "The target dir for deployment is '#{@build_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'
+        @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)"
+
+        @deployment_file = !!options[:deployment_file]
+
+        @gh_ref = "#{@gh_url}/#{slug}.git"
+        @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 gh_token
+        @gh_token ||= option(:github_token)
+      end
+
+      def gh_remote_url
+        @gh_remote_url ||= "https://#{gh_token}@#{@gh_ref}"
+      end
+
+      def fqdn
+        options.fetch(:fqdn) { nil }
+      end
+
+      def slug
+        options.fetch(:repo) { context.env['TRAVIS_REPO_SLUG'] }
+      end
+
+      def src_dir
+        context.env['TRAVIS_BUILD_DIR'] or Dir.pwd
+      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
+
+        return @api if @api
+
+        api_opts = { :access_token => @gh_token }
+        api_opts[:api_endpoint] = @gh_url == 'github.com' ? "https://api.github.com/" : "https://#{@gh_url}/api/v3/"
+
+        @api = Octokit::Client.new(api_opts)
+      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 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}\"" if @deployment_file
+        context.shell "echo '#{@gh_fqdn}' > CNAME" if @gh_fqdn
+        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
+        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
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: dpl-pages
+version: !ruby/object:Gem::Version
+  version: 1.9.0
+platform: ruby
+authors:
+- Konstantin Haase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dpl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: deploy tool abstraction for clients
+email: konstantin.mailinglists@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- dpl-pages.gemspec
+- lib/dpl/provider/pages.rb
+- spec/provider/pages_spec.rb
+homepage: https://github.com/travis-ci/dpl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: deploy tool
+test_files:
+- spec/provider/pages_spec.rb