capistrano-scm-gitbuild 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2017caa89477864994ae16126283a80252575c11
+  data.tar.gz: 7ebf88ddd079a63ff1001173954dea4ff4d74732
+SHA512:
+  metadata.gz: 92b124e5f0afcb505b7ae3fa8266242ab5763dfc14b883f0770ca435734a23bd65f04f4996c74505d2b80f2edddcdc701955022894d8b09139e4f4c4710d6612
+  data.tar.gz: 0b72945b07cd6f2a1322464cfd84d6274854803525254af0d2a6d49ea85d81e032ac9dbaecfbb55a27c281537dd2bc70e6bbdd387e12067098d28e782ba5ba65

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+/*.gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jochen Verdeyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Capistrano::GitBuild
+
+A Capistrano 3.x deploy strategy.
+
+The idea behind this strategy is to checkout the Git repository in a temporary directory first, on the local machine (the one which started the deploy task).
+
+Hereafter, custom build tasks can be implemented on the checkout code (e.g. compile your static site with [Jekyll](http://jekyllrb.com/), compile [SASS](http://sass-lang.com/) or import some external modules using [Composer](https://getcomposer.org/) for your project or anything else).
+
+Finally, the code will be archived in a tarball, uploaded to the servers and extracted in the release directory like normal.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-scm-gitbuild'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-scm-gitbuild
+
+## Usage
+
+Tell Capistrano to use the GitBuild deploy strategy, in `deploy.rb` like so:
+```ruby
+# Copy strategy
+set :scm, :gitbuild
+```
+
+To deploy a subdirectory instead of the full root of the project, you can of course use `:repo_tree` which is supported by default in Capistrano, in `deploy.rb` like so:
+```ruby
+# Deploy subdirectory
+set :repo_tree, 'project'
+```
+
+To implement your own build logic before the tarball is created and uploaded to the servers, you must implement the `gitbuild:build` task like so:
+```ruby
+namespace :gitbuild do
+  task :build do
+    run_locally do
+      # Implement custom build logic.
+    end
+  end
+end
+```
+
+When you deploy, the repository will be checked out first in a temporary directory (locally - on the machine which started the deploy task).
+After that you have the ability to implement custom build tasks.
+Finally, a tarball will be created, uploaded to all servers and extracted.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jover/capistrano-scm-gitbuild. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capistrano/gitbuild"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-scm-gitbuild.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/gitbuild/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-scm-gitbuild"
+  spec.version       = Capistrano::Gitbuild::VERSION
+  spec.authors       = ["Jochen Verdeyen"]
+  spec.email         = ["jochenverdeyen@gmail.com"]
+
+  spec.summary       = %q{GitBuild strategy for Capistrano 3}
+  spec.description   = %q{Capistrano 3 build and copy strategy for git (checkout branch, apply build steps and deploy to server)}
+  spec.homepage      = "https://github.com/jover/capistrano-scm-gitbuild"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capistrano', '~> 3.0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/capistrano/gitbuild.rb

@@ -0,0 +1,69 @@
+load File.expand_path('../tasks/gitbuild.rake', __FILE__)
+
+require "capistrano/scm"
+require "capistrano/gitbuild/version"
+
+set_if_empty :repo_path, -> { "#{fetch(:tmp_dir)}/#{fetch(:application)}-repo" }
+
+class Capistrano::GitBuild < Capistrano::SCM
+
+  # execute git with argument in the context
+  #
+  def git(*args)
+    args.unshift :git
+    context.execute(*args)
+  end
+
+  module DefaultStrategy
+    def test
+      test! " [ -f #{repo_path}/HEAD ] "
+    end
+
+    def check
+      git :'ls-remote --heads', repo_url
+    end
+
+    def clone
+      if (depth = fetch(:git_shallow_clone))
+        git :clone, '--mirror', '--depth', depth, '--no-single-branch', repo_url, repo_path
+      else
+        git :clone, '--mirror', repo_url, repo_path
+      end
+    end
+
+    def update
+      # Note: Requires git version 1.9 or greater
+      if (depth = fetch(:git_shallow_clone))
+        git :fetch, '--depth', depth, 'origin', fetch(:branch)
+      else
+        git :remote, :update
+      end
+    end
+
+    def local_build_path
+      "#{fetch(:repo_path)}"
+    end
+
+    def local_tarfile
+      "#{fetch(:tmp_dir)}/#{fetch(:application)}-#{fetch(:current_revision).strip}.tar.gz"
+    end
+
+    def remote_tarfile
+      "#{fetch(:tmp_dir)}/#{fetch(:application)}-#{fetch(:current_revision).strip}.tar.gz"
+    end
+
+    def release
+      if (tree = fetch(:repo_tree))
+        tree = tree.slice %r#^/?(.*?)/?$#, 1
+        components = tree.split('/').size
+        git :archive, fetch(:branch), tree, "| tar -x --strip-components #{components} -f - -C", local_build_path
+      else
+        git :archive, fetch(:branch), '| tar -x -f - -C', local_build_path
+      end
+    end
+
+    def fetch_revision
+      context.capture(:git, "rev-list --max-count=1 --abbrev-commit --abbrev=12 #{fetch(:branch)}")
+    end
+  end
+end

data/lib/capistrano/gitbuild/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Gitbuild
+    VERSION = "1.0.0"
+  end
+end

data/lib/capistrano/tasks/gitbuild.rake

@@ -0,0 +1,118 @@
+namespace :gitbuild do
+
+  def strategy
+    @strategy ||= Capistrano::GitBuild.new(self, fetch(:git_strategy, Capistrano::GitBuild::DefaultStrategy))
+  end
+
+  set :git_environmental_variables, ->() {
+    {
+      git_askpass: "/bin/echo",
+      git_ssh:     "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
+    }
+  }
+
+  desc 'Upload the git wrapper script, this script guarantees that we can script git without getting an interactive prompt'
+  task :wrapper do
+    run_locally do
+      execute :mkdir, "-p", "#{fetch(:tmp_dir)}/#{fetch(:application)}/"
+      File.open("#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh", "w") do |file|
+        file.write ("#!/bin/sh -e\nexec /usr/bin/ssh -o PasswordAuthentication=no -o StrictHostKeyChecking=no \"$@\"\n")
+      end
+      execute :chmod, "+rx", "#{fetch(:tmp_dir)}/#{fetch(:application)}/git-ssh.sh"
+    end
+  end
+
+  desc 'Check that the repository is reachable'
+  task check: :'gitbuild:wrapper' do
+    fetch(:branch)
+    run_locally do
+      with fetch(:git_environmental_variables) do
+        strategy.check
+      end
+    end
+  end
+
+  desc 'Clone the repo to the cache'
+  task clone: :'gitbuild:wrapper' do
+    run_locally do
+      execute :mkdir, '-p', repo_path
+      if strategy.test
+        info t(:mirror_exists, at: repo_path)
+      else
+        within repo_path do
+          with fetch(:git_environmental_variables) do
+            strategy.clone
+          end
+        end
+      end
+    end
+  end
+
+  desc 'Update the repo mirror to reflect the origin state'
+  task update: :'gitbuild:clone' do
+    run_locally do
+      within repo_path do
+        with fetch(:git_environmental_variables) do
+          strategy.update
+        end
+      end
+    end
+  end
+
+  desc 'Create tarfile'
+  task :create_tarfile => [:'gitbuild:update', :'gitbuild:set_current_revision'] do
+    run_locally do
+      within repo_path do
+        with fetch(:git_environmental_variables) do
+          strategy.release
+          invoke 'gitbuild:build'
+          execute :tar, '--create --verbose --file', strategy.local_tarfile, '--directory', strategy.local_build_path, '.'
+        end
+      end
+    end
+  end
+
+  desc 'Build hook'
+  task :build do
+    # Custom build logic, to be implemented by the project which uses this deploy strategy.
+    # 
+    # Implement like:
+    # |  namespace :gitbuild do
+    # |    task :build do
+    # |      run_locally do
+    # |        execute :jekyll, "build -s '#{fetch(:repo_path)}' -d '#{fetch(:repo_path)}/_site'"
+    # |      end
+    # |    end
+    # |  end
+  end
+
+  desc 'Copy repo to releases'
+  task create_release: :'gitbuild:create_tarfile' do
+    on release_roles :all do
+      within deploy_to do
+        execute :mkdir, '-p', release_path
+        upload! strategy.local_tarfile, strategy.remote_tarfile
+        execute :tar, '--extract --verbose --file', strategy.remote_tarfile, '--directory', release_path
+        execute :rm, strategy.remote_tarfile
+      end
+    end
+
+    run_locally do
+      if File.exists? strategy.local_tarfile
+        execute :rm, strategy.local_tarfile
+      end
+      if Dir.exists? strategy.local_build_path
+        execute :rm, '-r', strategy.local_build_path
+      end
+    end
+  end
+
+  desc 'Determine the revision that will be deployed'
+  task :set_current_revision do
+    run_locally do
+      with fetch(:git_environmental_variables) do
+        set :current_revision, strategy.fetch_revision
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-scm-gitbuild
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jochen Verdeyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+description: Capistrano 3 build and copy strategy for git (checkout branch, apply
+  build steps and deploy to server)
+email:
+- jochenverdeyen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-scm-gitbuild.gemspec
+- lib/capistrano/gitbuild.rb
+- lib/capistrano/gitbuild/version.rb
+- lib/capistrano/tasks/gitbuild.rake
+homepage: https://github.com/jover/capistrano-scm-gitbuild
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: GitBuild strategy for Capistrano 3
+test_files: []