Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/karlfreeman/middleman-deploy
Deploy a middleman built site over rsync, ftp, stfp, or git (e.g. gh-pages on github).
https://github.com/karlfreeman/middleman-deploy
Last synced: 1 day ago
JSON representation
Deploy a middleman built site over rsync, ftp, stfp, or git (e.g. gh-pages on github).
- Host: GitHub
- URL: https://github.com/karlfreeman/middleman-deploy
- Owner: karlfreeman
- License: mit
- Created: 2012-08-20T20:10:20.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2021-10-12T13:08:35.000Z (over 3 years ago)
- Last Synced: 2024-05-18T19:17:19.251Z (8 months ago)
- Language: Ruby
- Homepage:
- Size: 134 KB
- Stars: 553
- Watchers: 12
- Forks: 124
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - karlfreeman/middleman-deploy - Deploy a middleman built site over rsync, ftp, stfp, or git (e.g. gh-pages on github). (others)
README
# 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)).
## Installation
```ruby
gem 'middleman-deploy', '~> 1.0'
```
## Usage
```
$ 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.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.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.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.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:
```ruby
activate :deploy do |deploy|
# ...
deploy.build_before = true # default: false
end
```
### Multiple Environments
Deploy your site to more than one configuration using environment variables.
```ruby
# config.rb
case ENV['TARGET'].to_s.downcase
when 'production'
activate :deploy do |deploy|
deploy.method = :rsync
deploy.host = 'www.example.com'
deploy.path = '/srv/www/production-site'
end
else
activate :deploy do |deploy|
deploy.method = :rsync
deploy.host = 'staging.example.com'
deploy.path = '/srv/www/staging-site'
end
end
```
```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
end
```
```
$ rake deploy:staging
$ rake deploy:production
```
## Badges
[][gem]
[][travis]
[][codeclimate]
[][codeclimate]
[][gittip]
## Supported Ruby Versions
This library aims to support and is [tested against][travis] the following Ruby
implementations:
- Ruby 2.1.0
- Ruby 2.0.0
- Ruby 1.9.3
- [JRuby][jruby]
- [Rubinius][rubinius]
# Credits
A **BIG** thanks to [everyone who has contributed](https://github.com/karlfreeman/middleman-deploy/graphs/contributors)! Almost all pull requests are accepted.
Inspiration:
- 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