Compare commits
No commits in common. "master" and "v0.1.2" have entirely different histories.
16
.gitignore
vendored
16
.gitignore
vendored
|
|
@ -1,18 +1,2 @@
|
|||
*.gem
|
||||
*.rbc
|
||||
.bundle
|
||||
.config
|
||||
.yardoc
|
||||
Gemfile.lock
|
||||
InstalledFiles
|
||||
_yardoc
|
||||
coverage
|
||||
doc/
|
||||
lib/bundler/man
|
||||
pkg
|
||||
rdoc
|
||||
spec/reports
|
||||
test/tmp
|
||||
test/version_tmp
|
||||
tmp
|
||||
bin
|
||||
11
.rubocop.yml
11
.rubocop.yml
|
|
@ -1,11 +0,0 @@
|
|||
AllCops:
|
||||
Include:
|
||||
- 'Gemfile'
|
||||
Exclude:
|
||||
- 'script/**/*'
|
||||
- 'vendor/**/*'
|
||||
- 'bin/**/*'
|
||||
Documentation:
|
||||
Enabled: false
|
||||
ClassAndModuleChildren:
|
||||
Enabled: false
|
||||
26
.travis.yml
26
.travis.yml
|
|
@ -1,26 +0,0 @@
|
|||
language: ruby
|
||||
sudo: false
|
||||
cache: bundler
|
||||
bundler_args: --without development
|
||||
rvm:
|
||||
- ruby-head
|
||||
- ruby
|
||||
- jruby-head
|
||||
- jruby
|
||||
- 2.1.0
|
||||
- 2.0.0
|
||||
- 1.9.3
|
||||
- rbx-2
|
||||
before_script: bundle update
|
||||
matrix:
|
||||
fast_finish: true
|
||||
allow_failures:
|
||||
- rvm: ruby-head
|
||||
- rvm: ruby
|
||||
- rvm: jruby-head
|
||||
- rvm: jruby
|
||||
- rvm: rbx-2
|
||||
notifications:
|
||||
email: false
|
||||
env:
|
||||
- CODECLIMATE_REPO_TOKEN=5eee8e8624962f963a52a1d2313dc7407e3b8006291e3704346c786642cc073b
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
--markup markdown
|
||||
-
|
||||
CHANGELOG.md
|
||||
CONTRIBUTING.md
|
||||
LICENSE.md
|
||||
README.md
|
||||
12
CHANGELOG.md
12
CHANGELOG.md
|
|
@ -1,12 +0,0 @@
|
|||
Next Release
|
||||
============
|
||||
* Your contribution here.
|
||||
|
||||
2.0.0-alpha (02/08/2015)
|
||||
==================
|
||||
* [Fixing compatibility issues with middleman v4.0.0.beta.1](https://github.com/middleman-contrib/middleman-deploy/pull/87) - [@emilioforrer](https://github.com/emilioforrer).
|
||||
|
||||
1.0.0 (16/07/2014)
|
||||
==================
|
||||
* [Respect user details of git repo](https://github.com/middleman-contrib/middleman-deploy/pull/70) - [@Gee-Bee](https://github.com/gee-bee).
|
||||
* [Prevent bad commits deploying](https://github.com/middleman-contrib/middleman-deploy/pull/77) - [@karlfreeman](https://github.com/mconnell).
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
## Contributing
|
||||
In the spirit of [free software][free-sw], **everyone** is encouraged to help
|
||||
improve this project.
|
||||
|
||||
[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
|
||||
|
||||
Here are some ways *you* can contribute:
|
||||
|
||||
* by using alpha, beta, and prerelease versions
|
||||
* by reporting bugs
|
||||
* by suggesting new features
|
||||
* by writing or editing documentation
|
||||
* by writing specifications
|
||||
* by writing code (**no patch is too small**: fix typos, add comments, clean up
|
||||
inconsistent whitespace)
|
||||
* by refactoring code
|
||||
* by closing [issues][]
|
||||
* by reviewing patches
|
||||
|
||||
[issues]: https://github.com/karlfreeman/middleman-deploy/issues
|
||||
|
||||
## Submitting an Issue
|
||||
We use the [GitHub issue tracker][issues] to track bugs and features. Before
|
||||
submitting a bug report or feature request, check to make sure it hasn't
|
||||
already been submitted. When submitting a bug report, please include a [Gist][]
|
||||
that includes a stack trace and any details that may be necessary to reproduce
|
||||
the bug, including your gem version, Ruby version, and operating system.
|
||||
Ideally, a bug report should include a pull request with failing specs.
|
||||
|
||||
[gist]: https://gist.github.com/
|
||||
|
||||
## Submitting a Pull Request
|
||||
1. [Fork the repository.][fork]
|
||||
2. [Create a topic branch.][branch]
|
||||
3. Add specs for your unimplemented feature or bug fix.
|
||||
4. Run `bundle exec rake cucumber`. If your specs pass, return to step 3.
|
||||
5. Implement your feature or bug fix.
|
||||
6. Run `bundle exec rake cucumber`. If your specs fail, return to step 5.
|
||||
7. Add, commit, and push your changes.
|
||||
9. [Submit a pull request.][pr]
|
||||
|
||||
[fork]: http://help.github.com/fork-a-repo/
|
||||
[branch]: http://learn.github.com/p/branching.html
|
||||
[pr]: http://help.github.com/send-pull-requests/
|
||||
|
|
@ -1,6 +1,4 @@
|
|||
Copyright (c) 2012-2014 Tom Vaughan, Karl Freeman
|
||||
|
||||
MIT License
|
||||
Copyright (c) 2012 Tom Vaughan <thomas.david.vaughan@gmail.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
|
|
@ -10,13 +8,13 @@ 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 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.
|
||||
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.
|
||||
20
Gemfile
20
Gemfile
|
|
@ -1,11 +1,19 @@
|
|||
source 'https://rubygems.org'
|
||||
|
||||
# Specify your gem's dependencies in middleman-deploy.gemspec
|
||||
gemspec
|
||||
|
||||
group :test do
|
||||
gem 'rake', '~> 10.0'
|
||||
gem 'cucumber', '~> 1.3'
|
||||
gem 'aruba', '~> 0.5'
|
||||
gem 'fivemat'
|
||||
gem 'codeclimate-test-reporter'
|
||||
group :development do
|
||||
gem "rake"
|
||||
gem "rdoc"
|
||||
gem "yard"
|
||||
end
|
||||
|
||||
group :test do
|
||||
gem "compass"
|
||||
gem "cucumber"
|
||||
gem "fivemat"
|
||||
gem "aruba"
|
||||
gem "rspec"
|
||||
gem "simplecov"
|
||||
end
|
||||
|
|
|
|||
222
README.md
222
README.md
|
|
@ -1,13 +1,18 @@
|
|||
# Middleman Deploy
|
||||
# middleman-deploy [](https://travis-ci.org/tvaughan/middleman-deploy)
|
||||
|
||||
Deploy your [Middleman](http://middlemanapp.com/) build via **rsync**, **ftp**, **sftp**, or **git** (e.g. [gh-pages on github](https://help.github.com/articles/creating-project-pages-manually)).
|
||||
Deploys a [middleman](http://middlemanapp.com/) built site via **rsync**,
|
||||
**ftp**, **sftp**, or **git** (e.g. gh-pages on github).
|
||||
|
||||
## Installation
|
||||
|
||||
Add this to the Gemfile of the repository of your middleman site:
|
||||
|
||||
```ruby
|
||||
gem 'middleman-deploy', '~> 1.0'
|
||||
gem "middleman-deploy"
|
||||
```
|
||||
|
||||
and run `bundle install`.
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
|
|
@ -15,87 +20,6 @@ $ middleman build [--clean]
|
|||
$ middleman deploy [--build-before]
|
||||
```
|
||||
|
||||
## Possible Configurations
|
||||
|
||||
Middleman-deploy can deploy a site via rsync, ftp, sftp, or git. Checkout [the wiki](https://github.com/tvaughan/middleman-deploy/wiki/_pages) for advanced set-up options.
|
||||
|
||||
### Rsync
|
||||
|
||||
Make sure that `rsync` is installed, and activate the extension by adding the
|
||||
following to `config.rb`:
|
||||
|
||||
```ruby
|
||||
activate :deploy do |deploy|
|
||||
deploy.deploy_method = :rsync
|
||||
deploy.host = 'www.example.com'
|
||||
deploy.path = '/srv/www/site'
|
||||
# Optional Settings
|
||||
# deploy.user = 'tvaughan' # no default
|
||||
# deploy.port = 5309 # ssh port, default: 22
|
||||
# deploy.clean = true # remove orphaned files on remote host, default: false
|
||||
# deploy.flags = '-rltgoDvzO --no-p --del' # add custom flags, default: -avz
|
||||
end
|
||||
```
|
||||
|
||||
### Git (e.g. GitHub Pages)
|
||||
|
||||
Make sure that `git` is installed, and activate the extension by adding the
|
||||
following to `config.rb`:
|
||||
|
||||
```ruby
|
||||
activate :deploy do |deploy|
|
||||
deploy.deploy_method = :git
|
||||
# Optional Settings
|
||||
# deploy.remote = 'custom-remote' # remote name or git url, default: origin
|
||||
# deploy.branch = 'custom-branch' # default: gh-pages
|
||||
# deploy.strategy = :submodule # commit strategy: can be :force_push or :submodule, default: :force_push
|
||||
# deploy.commit_message = 'custom-message' # commit message (can be empty), default: Automated commit at `timestamp` by middleman-deploy `version`
|
||||
end
|
||||
```
|
||||
|
||||
If you use a remote name, you must first add it using `git remote add`. Run
|
||||
`git remote -v` to see a list of possible remote names. If you use a git url,
|
||||
it must end with '.git'.
|
||||
|
||||
Afterwards, the `build` directory will become a git repo.
|
||||
|
||||
If you use the force push strategy, this branch will be created on the remote if
|
||||
it doesn't already exist.
|
||||
But if you use the submodule strategy, you must first initialize build folder as
|
||||
a submodule. See `git submodule add` documentation.
|
||||
|
||||
### FTP
|
||||
|
||||
Activate the extension by adding the following to `config.rb`:
|
||||
|
||||
```ruby
|
||||
activate :deploy do |deploy|
|
||||
deploy.deploy_method = :ftp
|
||||
deploy.host = 'ftp.example.com'
|
||||
deploy.path = '/srv/www/site'
|
||||
deploy.user = 'tvaughan'
|
||||
deploy.password = 'secret'
|
||||
end
|
||||
```
|
||||
|
||||
### SFTP
|
||||
|
||||
Activate the extension by adding the following to `config.rb`:
|
||||
|
||||
```ruby
|
||||
activate :deploy do |deploy|
|
||||
deploy.deploy_method = :sftp
|
||||
deploy.host = 'sftp.example.com'
|
||||
deploy.port = 22
|
||||
deploy.path = '/srv/www/site'
|
||||
# Optional Settings
|
||||
# deploy.user = 'tvaughan' # no default
|
||||
# deploy.password = 'secret' # no default
|
||||
end
|
||||
```
|
||||
|
||||
### Run Automatically
|
||||
|
||||
To automatically run `middleman build` during `middleman deploy`, turn on the
|
||||
`build_before` option while activating the deploy extension:
|
||||
|
||||
|
|
@ -106,81 +30,95 @@ activate :deploy do |deploy|
|
|||
end
|
||||
```
|
||||
|
||||
### Multiple Environments
|
||||
## Possible Configurations
|
||||
|
||||
Deploy your site to more than one configuration using environment variables.
|
||||
Middleman-deploy can deploy a site via rsync, ftp, sftp, or git.
|
||||
|
||||
### rsync
|
||||
|
||||
Make sure that `rsync` is installed, and activate the extension by adding the
|
||||
following to `config.rb`:
|
||||
|
||||
```ruby
|
||||
# config.rb
|
||||
case ENV['TARGET'].to_s.downcase
|
||||
when 'production'
|
||||
activate :deploy do |deploy|
|
||||
deploy.deploy_method = :rsync
|
||||
deploy.host = 'www.example.com'
|
||||
deploy.path = '/srv/www/production-site'
|
||||
end
|
||||
else
|
||||
activate :deploy do |deploy|
|
||||
deploy.deploy_method = :rsync
|
||||
deploy.host = 'staging.example.com'
|
||||
deploy.path = '/srv/www/staging-site'
|
||||
end
|
||||
activate :deploy do |deploy|
|
||||
deploy.method = :rsync
|
||||
deploy.host = "www.example.com"
|
||||
deploy.path = "/srv/www/site"
|
||||
# Optional Settings
|
||||
# deploy.user = "tvaughan" # no default
|
||||
# deploy.port = 5309 # ssh port, default: 22
|
||||
# deploy.clean = true # remove orphaned files on remote host, default: false
|
||||
end
|
||||
```
|
||||
|
||||
### Git (e.g. GitHub Pages)
|
||||
|
||||
Make sure that `git` is installed, and activate the extension by adding the
|
||||
following to `config.rb`:
|
||||
|
||||
```ruby
|
||||
# Rakefile
|
||||
namespace :deploy do
|
||||
def deploy(env)
|
||||
puts "Deploying to #{env}"
|
||||
system "TARGET=#{env} bundle exec middleman deploy"
|
||||
end
|
||||
|
||||
task :staging do
|
||||
deploy :staging
|
||||
end
|
||||
|
||||
task :production do
|
||||
deploy :production
|
||||
end
|
||||
activate :deploy do |deploy|
|
||||
deploy.method = :git
|
||||
# Optional Settings
|
||||
# deploy.remote = "custom-remote" # remote name or git url, default: origin
|
||||
# deploy.branch = "custom-branch" # default: gh-pages
|
||||
end
|
||||
```
|
||||
|
||||
```
|
||||
$ rake deploy:staging
|
||||
$ rake deploy:production
|
||||
If you use a remote name, you must first add it using `git remote add`. Run
|
||||
`git remote -v` to see a list of possible remote names. If you use a git url,
|
||||
it must end with '.git'.
|
||||
|
||||
Afterwards, the `build` directory will become a git repo. This branch will be
|
||||
created on the remote if it doesn't already exist.
|
||||
|
||||
### FTP
|
||||
|
||||
Activate the extension by adding the following to `config.rb`:
|
||||
|
||||
```ruby
|
||||
activate :deploy do |deploy|
|
||||
deploy.method = :ftp
|
||||
deploy.host = "ftp.example.com"
|
||||
deploy.user = "tvaughan"
|
||||
deploy.password = "secret"
|
||||
deploy.path = "/srv/www/site"
|
||||
end
|
||||
```
|
||||
|
||||
## Badges
|
||||
### SFTP
|
||||
|
||||
[][gem]
|
||||
[][travis]
|
||||
[][codeclimate]
|
||||
[][codeclimate]
|
||||
[][gittip]
|
||||
Activate the extension by adding the following to `config.rb`:
|
||||
|
||||
## Supported Ruby Versions
|
||||
```ruby
|
||||
activate :deploy do |deploy|
|
||||
deploy.method = :sftp
|
||||
deploy.host = "sftp.example.com"
|
||||
deploy.user = "tvaughan"
|
||||
deploy.password = "secret"
|
||||
deploy.path = "/srv/www/site"
|
||||
end
|
||||
```
|
||||
|
||||
This library aims to support and is [tested against][travis] the following Ruby
|
||||
implementations:
|
||||
## Breaking Changes
|
||||
|
||||
- Ruby 2.1.0
|
||||
- Ruby 2.0.0
|
||||
- Ruby 1.9.3
|
||||
- [JRuby][jruby]
|
||||
- [Rubinius][rubinius]
|
||||
* `v0.1.0`
|
||||
- Removed the `--clean` command-line option. This option only applied to
|
||||
the rsync deploy method. The idea going forward is that command-line
|
||||
options must apply to all deploy methods. Options that are specific to a
|
||||
deploy method will only be available in `config.rb`.
|
||||
- Removed `deploy` from the `after_build` hook. This caused a `deploy` to
|
||||
be run each time `build` was called. This workflow never made
|
||||
sense. `deploy` was added to the `after_build` hook simply because it
|
||||
was available.
|
||||
|
||||
# Credits
|
||||
## Thanks!
|
||||
|
||||
A **BIG** thanks to [everyone who has contributed](https://github.com/karlfreeman/middleman-deploy/graphs/contributors)! Almost all pull requests are accepted.
|
||||
A **BIG** thanks to
|
||||
[everyone who has contributed](https://github.com/tvaughan/middleman-deploy/graphs/contributors)!
|
||||
Almost all pull requests are accepted.
|
||||
|
||||
Inspiration:
|
||||
## Other
|
||||
|
||||
- The rsync task in [Octopress](https://github.com/imathis/octopress)
|
||||
|
||||
[gem]: https://rubygems.org/gems/middleman-deploy
|
||||
[travis]: http://travis-ci.org/karlfreeman/middleman-deploy
|
||||
[codeclimate]: https://codeclimate.com/github/karlfreeman/middleman-deploy
|
||||
[gittip]: https://www.gittip.com/karlfreeman
|
||||
[jruby]: http://www.jruby.org
|
||||
[rubinius]: http://rubini.us
|
||||
Inspired by the rsync task in
|
||||
[Octopress](https://github.com/imathis/octopress).
|
||||
|
|
|
|||
38
Rakefile
38
Rakefile
|
|
@ -1,25 +1,35 @@
|
|||
require 'bundler'
|
||||
Bundler.setup
|
||||
Bundler::GemHelper.install_tasks
|
||||
|
||||
require 'cucumber/rake/task'
|
||||
|
||||
Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
|
||||
exempt_tags = ['--tags ~@wip']
|
||||
t.cucumber_opts = "--color #{exempt_tags.join(' ')} --strict --format #{ENV['CUCUMBER_FORMAT'] || 'Fivemat'}"
|
||||
t.cucumber_opts = "--color --tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'Fivemat'}"
|
||||
end
|
||||
|
||||
begin
|
||||
require 'yard'
|
||||
YARD::Rake::YardocTask.new
|
||||
rescue LoadError
|
||||
require 'rake/clean'
|
||||
|
||||
task :test => ["cucumber"]
|
||||
|
||||
require "middleman-deploy/pkg-info"
|
||||
|
||||
PACKAGE = "#{Middleman::Deploy::PACKAGE}"
|
||||
VERSION = "#{Middleman::Deploy::VERSION}"
|
||||
|
||||
task :package do
|
||||
system "gem build #{PACKAGE}.gemspec"
|
||||
end
|
||||
|
||||
begin
|
||||
require 'rubocop/rake_task'
|
||||
desc 'Run rubocop'
|
||||
RuboCop::RakeTask.new(:rubocop)
|
||||
rescue LoadError
|
||||
task :install => :package do
|
||||
Dir.chdir("pkg") do
|
||||
system "gem install #{PACKAGE}-#{VERSION}"
|
||||
end
|
||||
end
|
||||
|
||||
task default: :cucumber
|
||||
task test: :cucumber
|
||||
task :release => :package do
|
||||
Dir.chdir("pkg") do
|
||||
system "gem push #{PACKAGE}-#{VERSION}"
|
||||
end
|
||||
end
|
||||
|
||||
task :default => :test
|
||||
|
|
|
|||
|
|
@ -1,8 +1,6 @@
|
|||
require "simplecov"
|
||||
SimpleCov.start
|
||||
PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
|
||||
require 'middleman-core'
|
||||
require 'middleman-core/step_definitions'
|
||||
|
||||
require 'codeclimate-test-reporter'
|
||||
CodeClimate::TestReporter.start
|
||||
|
||||
require "middleman-core"
|
||||
require "middleman-core/step_definitions"
|
||||
require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-deploy')
|
||||
|
|
|
|||
|
|
@ -1,6 +0,0 @@
|
|||
Feature: test
|
||||
|
||||
Scenario: whilst testing
|
||||
Given the Server is running at "test-app"
|
||||
When I go to "/index.html"
|
||||
Then I should see "<h1>Test</h1>"
|
||||
|
|
@ -1 +0,0 @@
|
|||
<h1>Test</h1>
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
require 'middleman-core'
|
||||
require "middleman-core"
|
||||
|
||||
require 'middleman-deploy/commands'
|
||||
require "middleman-deploy/commands"
|
||||
|
||||
::Middleman::Extensions.register(:deploy) do
|
||||
require 'middleman-deploy/extension'
|
||||
::Middleman::Deploy::Extension
|
||||
require "middleman-deploy/extension"
|
||||
::Middleman::Deploy
|
||||
end
|
||||
|
|
|
|||
|
|
@ -1,119 +1,286 @@
|
|||
require 'middleman-core/cli'
|
||||
require 'middleman-core/rack' if Middleman::VERSION.to_i > 3
|
||||
require 'middleman-deploy/pkg-info'
|
||||
require 'middleman-deploy/extension'
|
||||
require 'middleman-deploy/methods'
|
||||
require 'middleman-deploy/strategies'
|
||||
require "middleman-core/cli"
|
||||
|
||||
require "middleman-deploy/extension"
|
||||
require "middleman-deploy/pkg-info"
|
||||
|
||||
module Middleman
|
||||
module Cli
|
||||
|
||||
# This class provides a "deploy" command for the middleman CLI.
|
||||
class Deploy < Thor::Group
|
||||
class Deploy < Thor
|
||||
include Thor::Actions
|
||||
|
||||
check_unknown_options!
|
||||
|
||||
namespace :deploy
|
||||
|
||||
class_option :environment,
|
||||
aliases: '-e',
|
||||
default: ENV['MM_ENV'] || ENV['RACK_ENV'] || 'production',
|
||||
desc: 'The environment Middleman will run under'
|
||||
|
||||
class_option :verbose,
|
||||
type: :boolean,
|
||||
default: false,
|
||||
desc: 'Print debug messages'
|
||||
|
||||
class_option :instrument,
|
||||
type: :string,
|
||||
default: false,
|
||||
desc: 'Print instrument messages'
|
||||
|
||||
class_option :build_before,
|
||||
type: :boolean,
|
||||
aliases: '-b',
|
||||
desc: 'Run `middleman build` before the deploy step'
|
||||
|
||||
def self.subcommand_help(_options)
|
||||
# TODO
|
||||
end
|
||||
|
||||
# Tell Thor to exit with a nonzero exit code on failure
|
||||
def self.exit_on_failure?
|
||||
true
|
||||
end
|
||||
|
||||
def deploy
|
||||
env = options['environment'] ? :production : options['environment'].to_s.to_sym
|
||||
verbose = options['verbose'] ? 0 : 1
|
||||
instrument = options['instrument']
|
||||
desc "deploy [options]", Middleman::Deploy::TAGLINE
|
||||
method_option "build_before",
|
||||
:type => :boolean,
|
||||
:aliases => "-b",
|
||||
:desc => "Run `middleman build` before the deploy step"
|
||||
|
||||
@app = ::Middleman::Application.new do
|
||||
config[:mode] = :build
|
||||
config[:environment] = env
|
||||
::Middleman::Logger.singleton(verbose, instrument)
|
||||
def deploy
|
||||
if options.has_key? "build_before"
|
||||
build_before = options.build_before
|
||||
else
|
||||
build_before = self.deploy_options.build_before
|
||||
end
|
||||
build_before(options)
|
||||
process
|
||||
if build_before
|
||||
# http://forum.middlemanapp.com/t/problem-with-the-build-task-in-an-extension
|
||||
run("middleman build") || exit(1)
|
||||
end
|
||||
send("deploy_#{self.deploy_options.method}")
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
def build_before(options = {})
|
||||
build_enabled = options.fetch('build_before', deploy_options.build_before)
|
||||
|
||||
if build_enabled
|
||||
# http://forum.middlemanapp.com/t/problem-with-the-build-task-in-an-extension
|
||||
run("middleman build -e #{options['environment']}") || exit(1)
|
||||
end
|
||||
end
|
||||
|
||||
def print_usage_and_die(message)
|
||||
fail StandardError, "ERROR: #{message}\n#{Middleman::Deploy::README}"
|
||||
raise Error, "ERROR: " + message + "\n" + <<EOF
|
||||
|
||||
You should follow one of the four examples below to setup the deploy
|
||||
extension in config.rb.
|
||||
|
||||
# To deploy the build directory to a remote host via rsync:
|
||||
activate :deploy do |deploy|
|
||||
deploy.method = :rsync
|
||||
# host and path *must* be set
|
||||
deploy.host = "www.example.com"
|
||||
deploy.path = "/srv/www/site"
|
||||
# user is optional (no default)
|
||||
deploy.user = "tvaughan"
|
||||
# port is optional (default is 22)
|
||||
deploy.port = 5309
|
||||
# clean is optional (default is false)
|
||||
deploy.clean = true
|
||||
end
|
||||
|
||||
# To deploy to a remote branch via git (e.g. gh-pages on github):
|
||||
activate :deploy do |deploy|
|
||||
deploy.method = :git
|
||||
# remote is optional (default is "origin")
|
||||
# run `git remote -v` to see a list of possible remotes
|
||||
deploy.remote = "some-other-remote-name"
|
||||
# branch is optional (default is "gh-pages")
|
||||
# run `git branch -a` to see a list of possible branches
|
||||
deploy.branch = "some-other-branch-name"
|
||||
end
|
||||
|
||||
# To deploy the build directory to a remote host via ftp:
|
||||
activate :deploy do |deploy|
|
||||
deploy.method = :ftp
|
||||
# host, user, passwword and path *must* be set
|
||||
deploy.host = "ftp.example.com"
|
||||
deploy.user = "tvaughan"
|
||||
deploy.password = "secret"
|
||||
deploy.path = "/srv/www/site"
|
||||
end
|
||||
|
||||
# To deploy the build directory to a remote host via sftp:
|
||||
activate :deploy do |deploy|
|
||||
deploy.method = :sftp
|
||||
# host, user, passwword and path *must* be set
|
||||
deploy.host = "sftp.example.com"
|
||||
deploy.user = "tvaughan"
|
||||
deploy.password = "secret"
|
||||
deploy.path = "/srv/www/site"
|
||||
end
|
||||
EOF
|
||||
end
|
||||
|
||||
def process
|
||||
server_instance = @app
|
||||
camelized_method = deploy_options.deploy_method.to_s.split('_').map(&:capitalize).join
|
||||
method_class_name = "Middleman::Deploy::Methods::#{camelized_method}"
|
||||
method_instance = method_class_name.constantize.new(server_instance, deploy_options)
|
||||
|
||||
method_instance.process
|
||||
def inst
|
||||
::Middleman::Application.server.inst
|
||||
end
|
||||
|
||||
def deploy_options
|
||||
options = nil
|
||||
|
||||
begin
|
||||
options = ::Middleman::Deploy.options
|
||||
rescue NoMethodError
|
||||
print_usage_and_die 'You need to activate the deploy extension in config.rb.'
|
||||
options = inst.options
|
||||
rescue
|
||||
print_usage_and_die "You need to activate the deploy extension in config.rb."
|
||||
end
|
||||
|
||||
unless options.deploy_method
|
||||
print_usage_and_die 'The deploy extension requires you to set a method.'
|
||||
if (!options.method)
|
||||
print_usage_and_die "The deploy extension requires you to set a method."
|
||||
end
|
||||
|
||||
case options.deploy_method
|
||||
when :rsync, :sftp
|
||||
unless options.host && options.path
|
||||
print_usage_and_die "The #{options.deploy_method} method requires host and path to be set."
|
||||
case options.method
|
||||
when :rsync
|
||||
if (!options.host || !options.path)
|
||||
print_usage_and_die "The rsync deploy method requires host and path to be set."
|
||||
end
|
||||
when :ftp
|
||||
unless options.host && options.user && options.password && options.path
|
||||
print_usage_and_die 'The ftp deploy method requires host, path, user, and password to be set.'
|
||||
when :ftp, :sftp
|
||||
if (!options.host || !options.user || !options.password || !options.path)
|
||||
print_usage_and_die "The #{options.method} method requires host, user, password, and path to be set."
|
||||
end
|
||||
end
|
||||
|
||||
options
|
||||
end
|
||||
|
||||
def deploy_rsync
|
||||
host = self.deploy_options.host
|
||||
port = self.deploy_options.port
|
||||
path = self.deploy_options.path
|
||||
|
||||
# Append "@" to user if provided.
|
||||
user = self.deploy_options.user
|
||||
user = "#{user}@" if user && !user.empty?
|
||||
|
||||
dest_url = "#{user}#{host}:#{path}"
|
||||
|
||||
puts "## Deploying via rsync to #{dest_url} port=#{port}"
|
||||
|
||||
command = "rsync -avze '" + "ssh -p #{port}" + "' #{self.inst.build_dir}/ #{dest_url}"
|
||||
|
||||
if self.deploy_options.clean
|
||||
command += " --delete"
|
||||
end
|
||||
|
||||
run command
|
||||
end
|
||||
|
||||
def deploy_git
|
||||
remote = self.deploy_options.remote
|
||||
branch = self.deploy_options.branch
|
||||
|
||||
puts "## Deploying via git to remote=\"#{remote}\" and branch=\"#{branch}\""
|
||||
|
||||
#check if remote is not a git url
|
||||
unless remote =~ /\.git$/
|
||||
remote = `git config --get remote.#{remote}.url`.chop
|
||||
end
|
||||
|
||||
#if the remote name doesn't exist in the main repo
|
||||
if remote == ''
|
||||
puts "Can't deploy! Please add a remote with the name '#{self.deploy_options.remote}' to your repo."
|
||||
exit
|
||||
end
|
||||
|
||||
Dir.chdir(self.inst.build_dir) do
|
||||
unless File.exists?('.git')
|
||||
`git init`
|
||||
`git remote add origin #{remote}`
|
||||
else
|
||||
#check if the remote repo has changed
|
||||
unless remote == `git config --get remote.origin.url`.chop
|
||||
`git remote rm origin`
|
||||
`git remote add origin #{remote}`
|
||||
end
|
||||
end
|
||||
|
||||
#if there is a branch with that name, switch to it, otherwise create a new one and switch to it
|
||||
if `git branch`.split("\n").any? { |b| b =~ /#{branch}/i }
|
||||
`git checkout #{branch}`
|
||||
else
|
||||
`git checkout -b #{branch}`
|
||||
end
|
||||
|
||||
`git add -A`
|
||||
`git commit --allow-empty -am 'Automated commit at #{Time.now.utc} by #{Middleman::Deploy::PACKAGE} #{Middleman::Deploy::VERSION}'`
|
||||
`git push -f origin #{branch}`
|
||||
end
|
||||
end
|
||||
|
||||
def deploy_ftp
|
||||
require 'net/ftp'
|
||||
require 'ptools'
|
||||
|
||||
host = self.deploy_options.host
|
||||
user = self.deploy_options.user
|
||||
pass = self.deploy_options.password
|
||||
path = self.deploy_options.path
|
||||
|
||||
puts "## Deploying via ftp to #{user}@#{host}:#{path}"
|
||||
|
||||
ftp = Net::FTP.new(host)
|
||||
ftp.login(user, pass)
|
||||
ftp.chdir(path)
|
||||
ftp.passive = true
|
||||
|
||||
Dir.chdir(self.inst.build_dir) do
|
||||
files = Dir.glob('**/*', File::FNM_DOTMATCH)
|
||||
files.reject { |a| a =~ Regexp.new('\.$') }.each do |f|
|
||||
if File.directory?(f)
|
||||
begin
|
||||
ftp.mkdir(f)
|
||||
puts "Created directory #{f}"
|
||||
rescue
|
||||
end
|
||||
else
|
||||
begin
|
||||
if File.binary?(f)
|
||||
ftp.putbinaryfile(f, f)
|
||||
else
|
||||
ftp.puttextfile(f, f)
|
||||
end
|
||||
rescue Exception => e
|
||||
reply = e.message
|
||||
err_code = reply[0,3].to_i
|
||||
if err_code == 550
|
||||
if File.binary?(f)
|
||||
ftp.putbinaryfile(f, f)
|
||||
else
|
||||
ftp.puttextfile(f, f)
|
||||
end
|
||||
end
|
||||
end
|
||||
puts "Copied #{f}"
|
||||
end
|
||||
end
|
||||
end
|
||||
ftp.close
|
||||
end
|
||||
|
||||
def deploy_sftp
|
||||
require 'net/sftp'
|
||||
require 'ptools'
|
||||
|
||||
host = self.deploy_options.host
|
||||
user = self.deploy_options.user
|
||||
pass = self.deploy_options.password
|
||||
path = self.deploy_options.path
|
||||
|
||||
puts "## Deploying via sftp to #{user}@#{host}:#{path}"
|
||||
|
||||
Net::SFTP.start(host, user, :password => pass) do |sftp|
|
||||
sftp.mkdir(path)
|
||||
Dir.chdir(self.inst.build_dir) do
|
||||
files = Dir.glob('**/*', File::FNM_DOTMATCH)
|
||||
files.reject { |a| a =~ Regexp.new('\.$') }.each do |f|
|
||||
if File.directory?(f)
|
||||
begin
|
||||
sftp.mkdir("#{path}/#{f}")
|
||||
puts "Created directory #{f}"
|
||||
rescue
|
||||
end
|
||||
else
|
||||
begin
|
||||
sftp.upload(f, "#{path}/#{f}")
|
||||
rescue Exception => e
|
||||
reply = e.message
|
||||
err_code = reply[0,3].to_i
|
||||
if err_code == 550
|
||||
sftp.upload(f, "#{path}/#{f}")
|
||||
end
|
||||
end
|
||||
puts "Copied #{f}"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# Add to CLI
|
||||
Base.register(Middleman::Cli::Deploy, 'deploy', 'deploy [options]', Middleman::Deploy::TAGLINE)
|
||||
|
||||
# Alias "d" to "deploy"
|
||||
Base.map('d' => 'deploy')
|
||||
Base.map({ "d" => "deploy" })
|
||||
|
||||
end
|
||||
end
|
||||
|
|
|
|||
|
|
@ -1,35 +1,20 @@
|
|||
# Require core library
|
||||
require 'middleman-core'
|
||||
require "middleman-core"
|
||||
|
||||
# Extension namespace
|
||||
module Middleman
|
||||
module Deploy
|
||||
@options
|
||||
|
||||
class Options < Struct.new(:whatisthis, :method, :host, :port, :user, :password, :path, :clean, :remote, :branch, :build_before); end
|
||||
|
||||
class << self
|
||||
attr_reader :options
|
||||
|
||||
attr_writer :options
|
||||
end
|
||||
|
||||
class Extension < Extension
|
||||
option :deploy_method, nil
|
||||
option :host, nil
|
||||
option :port, nil
|
||||
option :user, nil
|
||||
option :password, nil
|
||||
option :path, nil
|
||||
option :clean, nil
|
||||
option :remote, nil
|
||||
option :branch, nil
|
||||
option :strategy, nil
|
||||
option :build_before, nil
|
||||
option :flags, nil
|
||||
option :commit_message, nil
|
||||
|
||||
def initialize(app, options_hash = {}, &block)
|
||||
super
|
||||
def options
|
||||
@@options
|
||||
end
|
||||
|
||||
def registered(app, options_hash={}, &block)
|
||||
options = Options.new(options_hash)
|
||||
yield options if block_given?
|
||||
|
||||
# Default options for the rsync method.
|
||||
|
|
@ -37,17 +22,25 @@ module Middleman
|
|||
options.clean ||= false
|
||||
|
||||
# Default options for the git method.
|
||||
options.remote ||= 'origin'
|
||||
options.branch ||= 'gh-pages'
|
||||
options.strategy ||= :force_push
|
||||
options.commit_message ||= nil
|
||||
options.remote ||= "origin"
|
||||
options.branch ||= "gh-pages"
|
||||
|
||||
options.build_before ||= false
|
||||
|
||||
@@options = options
|
||||
|
||||
app.send :include, Helpers
|
||||
end
|
||||
|
||||
def after_configuration
|
||||
::Middleman::Deploy.options = options
|
||||
alias :included :registered
|
||||
|
||||
end
|
||||
|
||||
module Helpers
|
||||
def options
|
||||
::Middleman::Deploy.options
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
|
|
|
|||
|
|
@ -1,5 +0,0 @@
|
|||
require 'middleman-deploy/methods/base'
|
||||
require 'middleman-deploy/methods/ftp'
|
||||
require 'middleman-deploy/methods/git'
|
||||
require 'middleman-deploy/methods/rsync'
|
||||
require 'middleman-deploy/methods/sftp'
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
module Middleman
|
||||
module Deploy
|
||||
module Methods
|
||||
class Base
|
||||
attr_reader :options, :server_instance
|
||||
|
||||
def initialize(server_instance, options = {})
|
||||
@options = options
|
||||
@server_instance = server_instance
|
||||
end
|
||||
|
||||
def build_dir
|
||||
server_instance.config.setting(:build_dir).value
|
||||
end
|
||||
|
||||
def process
|
||||
fail NotImplementedError
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
@ -1,86 +0,0 @@
|
|||
require 'net/ftp'
|
||||
require 'ptools'
|
||||
|
||||
module Middleman
|
||||
module Deploy
|
||||
module Methods
|
||||
class Ftp < Base
|
||||
attr_reader :host, :port, :pass, :path, :user
|
||||
|
||||
def initialize(server_instance, options = {})
|
||||
super(server_instance, options)
|
||||
|
||||
@host = self.options.host
|
||||
@user = self.options.user
|
||||
@pass = self.options.password
|
||||
@path = self.options.path
|
||||
@port = self.options.port
|
||||
end
|
||||
|
||||
def process
|
||||
puts "## Deploying via ftp to #{user}@#{host}:#{path}"
|
||||
|
||||
ftp = open_connection
|
||||
|
||||
Dir.chdir(build_dir) do
|
||||
filtered_files.each do |filename|
|
||||
if File.directory?(filename)
|
||||
upload_directory(ftp, filename)
|
||||
else
|
||||
upload_binary(ftp, filename)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
ftp.close
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
def filtered_files
|
||||
files = Dir.glob('**/*', File::FNM_DOTMATCH)
|
||||
|
||||
files.reject { |filename| filename =~ Regexp.new('\.$') }
|
||||
end
|
||||
|
||||
def handle_exception(exception, ftp, filename)
|
||||
reply = exception.message
|
||||
err_code = reply[0, 3].to_i
|
||||
|
||||
if err_code == 550
|
||||
if File.binary?(filename)
|
||||
ftp.putbinaryfile(filename, filename)
|
||||
else
|
||||
ftp.puttextfile(filename, filename)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def open_connection
|
||||
ftp = Net::FTP.new(host)
|
||||
ftp.login(user, pass)
|
||||
ftp.chdir(path)
|
||||
ftp.passive = true
|
||||
|
||||
ftp
|
||||
end
|
||||
|
||||
def upload_binary(ftp, filename)
|
||||
begin
|
||||
ftp.putbinaryfile(filename, filename)
|
||||
rescue Exception => exception
|
||||
handle_exception(exception, ftp, filename)
|
||||
end
|
||||
|
||||
puts "Copied #{filename}"
|
||||
end
|
||||
|
||||
def upload_directory(ftp, filename)
|
||||
ftp.mkdir(filename)
|
||||
puts "Created directory #{filename}"
|
||||
rescue
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
module Middleman
|
||||
module Deploy
|
||||
module Methods
|
||||
class Git < Base
|
||||
def process
|
||||
puts "## Deploying via git to remote=\"#{options.remote}\" and branch=\"#{options.branch}\""
|
||||
|
||||
camelized_strategy = options.strategy.to_s.split('_').map(&:capitalize).join
|
||||
strategy_class_name = "Middleman::Deploy::Strategies::Git::#{camelized_strategy}"
|
||||
strategy_instance = strategy_class_name.constantize.new(build_dir, options.remote, options.branch, options.commit_message)
|
||||
|
||||
strategy_instance.process
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
module Middleman
|
||||
module Deploy
|
||||
module Methods
|
||||
class Rsync < Base
|
||||
attr_reader :clean, :flags, :host, :path, :port, :user
|
||||
|
||||
def initialize(server_instance, options = {})
|
||||
super(server_instance, options)
|
||||
|
||||
@clean = self.options.clean
|
||||
@flags = self.options.flags
|
||||
@host = self.options.host
|
||||
@path = self.options.path
|
||||
@port = self.options.port
|
||||
@user = self.options.user
|
||||
end
|
||||
|
||||
def process
|
||||
# Append "@" to user if provided.
|
||||
user = "#{self.user}@" if user && !user.empty?
|
||||
|
||||
dest_url = "#{user}#{host}:#{path}"
|
||||
flags = self.flags || '-avz'
|
||||
command = "rsync #{flags} '-e ssh -p #{port}' #{build_dir}/ #{dest_url}"
|
||||
|
||||
command += ' --delete' if clean
|
||||
|
||||
puts "## Deploying via rsync to #{dest_url} port=#{port}"
|
||||
exec command
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
@ -1,60 +0,0 @@
|
|||
require 'net/sftp'
|
||||
require 'ptools'
|
||||
|
||||
module Middleman
|
||||
module Deploy
|
||||
module Methods
|
||||
class Sftp < Ftp
|
||||
def process
|
||||
puts "## Deploying via sftp to #{user}@#{host}:#{path}"
|
||||
|
||||
# `nil` is a valid value for user and/or pass.
|
||||
Net::SFTP.start(host, user, password: pass, port: port) do |sftp|
|
||||
sftp.mkdir(path)
|
||||
|
||||
Dir.chdir(build_dir) do
|
||||
filtered_files.each do |filename|
|
||||
if File.directory?(filename)
|
||||
upload_directory(sftp, filename)
|
||||
else
|
||||
upload_file(sftp, filename)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
def handle_exception(exception, filename, file_path)
|
||||
reply = exception.message
|
||||
err_code = reply[0, 3].to_i
|
||||
|
||||
sftp.upload(filename, file_path) if err_code == 550
|
||||
end
|
||||
|
||||
def upload_directory(sftp, filename)
|
||||
file_path = "#{path}/#{filename}"
|
||||
|
||||
begin
|
||||
sftp.mkdir(file_path)
|
||||
puts "Created directory #{filename}"
|
||||
rescue
|
||||
end
|
||||
end
|
||||
|
||||
def upload_file(sftp, filename)
|
||||
file_path = "#{path}/#{filename}"
|
||||
|
||||
begin
|
||||
sftp.upload(filename, file_path)
|
||||
rescue Exception => exception
|
||||
handle_exception(exception, filename, file_path)
|
||||
end
|
||||
|
||||
puts "Copied #{filename}"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
@ -1,64 +1,7 @@
|
|||
module Middleman
|
||||
module Deploy
|
||||
PACKAGE = 'middleman-deploy'
|
||||
VERSION = '2.0.0-alpha'
|
||||
TAGLINE = 'Deploy a middleman built site over rsync, ftp, sftp, or git (e.g. gh-pages on github).'
|
||||
README = %{
|
||||
You should follow one of the four examples below to setup the deploy
|
||||
extension in config.rb.
|
||||
|
||||
# To deploy the build directory to a remote host via rsync:
|
||||
activate :deploy do |deploy|
|
||||
deploy.method = :rsync
|
||||
# host and path *must* be set
|
||||
deploy.host = "www.example.com"
|
||||
deploy.path = "/srv/www/site"
|
||||
# user is optional (no default)
|
||||
deploy.user = "tvaughan"
|
||||
# port is optional (default is 22)
|
||||
deploy.port = 5309
|
||||
# clean is optional (default is false)
|
||||
deploy.clean = true
|
||||
# flags is optional (default is -avze)
|
||||
deploy.flags = "-rltgoDvzO --no-p --del -e"
|
||||
end
|
||||
|
||||
# To deploy to a remote branch via git (e.g. gh-pages on github):
|
||||
activate :deploy do |deploy|
|
||||
deploy.method = :git
|
||||
# remote is optional (default is "origin")
|
||||
# run `git remote -v` to see a list of possible remotes
|
||||
deploy.remote = "some-other-remote-name"
|
||||
|
||||
# branch is optional (default is "gh-pages")
|
||||
# run `git branch -a` to see a list of possible branches
|
||||
deploy.branch = "some-other-branch-name"
|
||||
|
||||
# strategy is optional (default is :force_push)
|
||||
deploy.strategy = :submodule
|
||||
end
|
||||
|
||||
# To deploy the build directory to a remote host via ftp:
|
||||
activate :deploy do |deploy|
|
||||
deploy.method = :ftp
|
||||
# host, user, passwword and path *must* be set
|
||||
deploy.host = "ftp.example.com"
|
||||
deploy.path = "/srv/www/site"
|
||||
deploy.user = "tvaughan"
|
||||
deploy.password = "secret"
|
||||
end
|
||||
|
||||
# To deploy the build directory to a remote host via sftp:
|
||||
activate :deploy do |deploy|
|
||||
deploy.method = :sftp
|
||||
# host, user, passwword and path *must* be set
|
||||
deploy.host = "sftp.example.com"
|
||||
deploy.port = 22
|
||||
deploy.path = "/srv/www/site"
|
||||
# user is optional (no default)
|
||||
deploy.user = "tvaughan"
|
||||
# password is optional (no default)
|
||||
deploy.password = "secret"
|
||||
end}
|
||||
PACKAGE = "middleman-deploy"
|
||||
VERSION = "0.1.2"
|
||||
TAGLINE = "Deploy a middleman built site over rsync, ftp, sftp, or git (e.g. gh-pages on github)."
|
||||
end
|
||||
end
|
||||
|
|
|
|||
|
|
@ -1,3 +0,0 @@
|
|||
require 'middleman-deploy/strategies/git/base'
|
||||
require 'middleman-deploy/strategies/git/force_push'
|
||||
require 'middleman-deploy/strategies/git/submodule'
|
||||
|
|
@ -1,56 +0,0 @@
|
|||
module Middleman
|
||||
module Deploy
|
||||
module Strategies
|
||||
module Git
|
||||
class Base
|
||||
attr_accessor :branch, :build_dir, :remote, :commit_message, :user_name, :user_email
|
||||
|
||||
def initialize(build_dir, remote, branch, commit_message)
|
||||
self.branch = branch
|
||||
self.build_dir = build_dir
|
||||
self.remote = remote
|
||||
self.commit_message = commit_message
|
||||
self.user_name = `git config --get user.name`
|
||||
self.user_email = `git config --get user.email`
|
||||
end
|
||||
|
||||
def process
|
||||
fail NotImplementedError
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
def add_signature_to_commit_message(base_message)
|
||||
signature = "#{Middleman::Deploy::PACKAGE} #{Middleman::Deploy::VERSION}"
|
||||
time = "#{Time.now.utc}"
|
||||
|
||||
"#{base_message} at #{time} by #{signature}"
|
||||
end
|
||||
|
||||
def checkout_branch
|
||||
# if there is a branch with that name, switch to it, otherwise create a new one and switch to it
|
||||
if `git branch`.split("\n").any? { |b| b =~ /#{branch}/i }
|
||||
`git checkout #{branch}`
|
||||
else
|
||||
`git checkout -b #{branch}`
|
||||
end
|
||||
end
|
||||
|
||||
def commit_branch(options = '')
|
||||
message = commit_message ? commit_message : add_signature_to_commit_message('Automated commit')
|
||||
|
||||
run_or_fail('git add -A')
|
||||
run_or_fail("git commit --allow-empty -am \"#{message}\"")
|
||||
run_or_fail("git push #{options} origin #{branch}")
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def run_or_fail(command)
|
||||
system(command) || fail("ERROR running: #{command}")
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
@ -1,58 +0,0 @@
|
|||
module Middleman
|
||||
module Deploy
|
||||
module Strategies
|
||||
module Git
|
||||
class ForcePush < Base
|
||||
def process
|
||||
Dir.chdir(build_dir) do
|
||||
add_remote_url
|
||||
checkout_branch
|
||||
commit_branch('-f')
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def add_remote_url
|
||||
url = get_remote_url
|
||||
|
||||
unless File.exist?('.git')
|
||||
`git init`
|
||||
`git remote add origin #{url}`
|
||||
`git config user.name "#{user_name}"`
|
||||
`git config user.email "#{user_email}"`
|
||||
else
|
||||
# check if the remote repo has changed
|
||||
unless url == `git config --get remote.origin.url`.chop
|
||||
`git remote rm origin`
|
||||
`git remote add origin #{url}`
|
||||
end
|
||||
# check if the user name has changed
|
||||
`git config user.name "#{user_name}"` unless user_name == `git config --get user.name`
|
||||
# check if the user email has changed
|
||||
`git config user.email "#{user_email}"` unless user_email == `git config --get user.email`
|
||||
end
|
||||
end
|
||||
|
||||
def get_remote_url
|
||||
remote = self.remote
|
||||
url = remote
|
||||
|
||||
# check if remote is not a git url
|
||||
unless remote =~ /\.git$/
|
||||
url = `git config --get remote.#{url}.url`.chop
|
||||
end
|
||||
|
||||
# if the remote name doesn't exist in the main repo
|
||||
if url == ''
|
||||
puts "Can't deploy! Please add a remote with the name '#{remote}' to your repo."
|
||||
exit
|
||||
end
|
||||
|
||||
url
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
module Middleman
|
||||
module Deploy
|
||||
module Strategies
|
||||
module Git
|
||||
class Submodule < Base
|
||||
def process
|
||||
Dir.chdir(build_dir) do
|
||||
checkout_branch
|
||||
pull_submodule
|
||||
commit_branch
|
||||
end
|
||||
|
||||
commit_submodule
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def commit_submodule
|
||||
current_branch = `git rev-parse --abbrev-ref HEAD`
|
||||
message = add_signature_to_commit_message('Deployed')
|
||||
|
||||
`git add #{build_dir}`
|
||||
`git commit --allow-empty -m "#{message}"`
|
||||
`git push origin #{current_branch}`
|
||||
end
|
||||
|
||||
def pull_submodule
|
||||
`git fetch`
|
||||
`git stash`
|
||||
`git rebase #{remote}/#{branch}`
|
||||
`git stash pop`
|
||||
|
||||
if $CHILD_STATUS.exitstatus == 1
|
||||
puts "Can't deploy! Please resolve conflicts. Then process to manual commit and push on #{branch} branch."
|
||||
exit
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
@ -1 +1 @@
|
|||
require 'middleman-deploy'
|
||||
require "middleman-deploy"
|
||||
|
|
@ -1,32 +1,27 @@
|
|||
# coding: utf-8
|
||||
lib = File.expand_path('../lib', __FILE__)
|
||||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
||||
require 'middleman-deploy/pkg-info'
|
||||
# -*- encoding: utf-8 -*-
|
||||
$:.push File.expand_path("../lib", __FILE__)
|
||||
require "middleman-deploy/pkg-info"
|
||||
|
||||
Gem::Specification.new do |spec|
|
||||
spec.name = Middleman::Deploy::PACKAGE
|
||||
spec.version = Middleman::Deploy::VERSION
|
||||
spec.authors = ['Tom Vaughan', 'Karl Freeman']
|
||||
spec.email = ['thomas.david.vaughan@gmail.com', 'karlfreeman@gmail.com']
|
||||
spec.summary = Middleman::Deploy::TAGLINE
|
||||
spec.description = Middleman::Deploy::TAGLINE
|
||||
spec.homepage = 'https://github.com/karlfreeman/middleman-deploy'
|
||||
spec.license = 'MIT'
|
||||
Gem::Specification.new do |s|
|
||||
s.name = Middleman::Deploy::PACKAGE
|
||||
s.version = Middleman::Deploy::VERSION
|
||||
s.platform = Gem::Platform::RUBY
|
||||
s.authors = ["Tom Vaughan"]
|
||||
s.email = ["thomas.david.vaughan@gmail.com"]
|
||||
s.homepage = "http://tvaughan.github.io/middleman-deploy/"
|
||||
s.summary = Middleman::Deploy::TAGLINE
|
||||
s.description = Middleman::Deploy::TAGLINE
|
||||
s.license = "MIT"
|
||||
|
||||
spec.files = `git ls-files -z`.split("\x0")
|
||||
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
||||
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
||||
spec.require_paths = ['lib']
|
||||
spec.required_ruby_version = '>= 1.9.3'
|
||||
s.files = `git ls-files`.split("\n")
|
||||
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
||||
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
||||
s.require_paths = ["lib"]
|
||||
|
||||
spec.add_dependency 'middleman-core', '>= 3.2'
|
||||
spec.add_dependency 'ptools'
|
||||
spec.add_dependency 'net-sftp'
|
||||
# The version of middleman-core your extension depends on
|
||||
s.add_runtime_dependency("middleman-core", [">= 3.0.0"])
|
||||
|
||||
spec.add_development_dependency 'bundler', '~> 1.5'
|
||||
spec.add_development_dependency 'rake', '~> 10.0'
|
||||
spec.add_development_dependency 'kramdown', '>= 0.14'
|
||||
spec.add_development_dependency 'rubocop', '~> 0.19'
|
||||
spec.add_development_dependency 'pry'
|
||||
spec.add_development_dependency 'yard'
|
||||
# Additional dependencies
|
||||
s.add_runtime_dependency("ptools")
|
||||
s.add_runtime_dependency("net-sftp")
|
||||
end
|
||||
|
|
|
|||
Loading…
Reference in a new issue