capistrano-wp 0.4.1 → 0.4.2

data/README.md

@@ -11,30 +11,24 @@ also deploy multisite environments with WP at the root).
 
 ## Usage
 
-This is a very early release, and the usage is not extremely well documented.  A minimal Capfile might look like this:
-
-	require 'rubygems'
-	require 'railsless-deploy'
-	require 'crowdfavorite/wordpress'
-	# tags/3.4.1, branches/3.4, trunk
-	set :wordpress_version, "branches/3.4"
-	set :application, "wp.example.com"
-	set :scm, :git
-	set :repository, "git@github.com:example/wordpress-site.git"
-	set :git_enable_submodules, 1
-	set :user, 'wpdeploy'
-	server 'web.example.com', :app, :web, :primary => true
-	# Deploy to /var/www/domains/wp.example.com/htdocs
-	# Link uploads, blogs.dir, cache from /var/www/domains/wp.example.com/shared 
-	# to /var/www/domains/wp.example.com/htdocs/wp-content
-	# Install WordPress into /var/www/domains/wp.example.com/htdocs/wp
-	set :base_dir, '/var/www/domains'
-	set :deploy_to, File.join(base_dir, application)
-	set :current_dir, 'htdocs'
-	set(:wp_path) { File.join(release_path, 'wp') }
-	set :deploy_via, :remote_cache
-
-Also see the `:wp_symlinks` and `:wp_configs` settings in the source.
+See `doc/examples` for an example Capfile and capistrano config directory.
+
+General Capistrano usage:
+
+1. Create a user for deploying your WordPress install
+2. Create an SSH key for the deploy user, and make sure you can SSH to it from your local machine
+3. [Install RubyGems][rubygems].  Crowd Favorite prefers to use [RVM][rvm] to maintain ruby versions, rubygems, and self-contained sets of gems.
+4. Install the capistrano-wp gem (which will install Capistrano and friends): `gem install capistrano-wp`
+5. Ensure that your project is in a repository starting at the web root
+6. Copy the example configuration (from doc/examples) into the root of your repository, and customize as appropriate
+7. Make sure your `:deploy_to` path exists and is owned by the deploy user
+8. Run `cap deploy:setup` to set up the initial directories
+9. Run `cap deploy` to push out a new version of your code
+10. Update your web server configuration to point to the current-release directory (in the `:deply_to` directory, named `httpdocs` by default)
+11. Relax and enjoy painless deployment
+
+[rubygems]: http://rubygems.org/pages/download
+[rvm]: https://rvm.io/
 
 ## Development
 
@@ -48,5 +42,5 @@ When updating the gem requirements:
 
 # Copyright
 
-Copyright (c) 2012 Crowd Favorite, Ltd. See LICENSE.txt for further details.
+Copyright (c) 2012-2013 Crowd Favorite, Ltd. Released under the Apache License, version 2.0. See LICENSE.txt for further details.
 

data/Rakefile

@@ -1,4 +1,17 @@
 # encoding: utf-8
+# Copyright 2012-2013 Crowd Favorite, Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
 require 'rubygems'
 require 'bundler'
@@ -16,13 +29,13 @@ Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "capistrano-wp"
   gem.homepage = "http://github.com/crowdfavorite/gem-capistrano-wp"
-  gem.license = "GPL"
+  gem.license = "Apache License version 2"
   gem.summary = %Q{Crowd Favorite WordPress Capistrano recipes}
-  gem.description = <<-EOF
+  gem.description = <<-EOF.gsub(/^ {4}/, '')
     Recipes for deploying and maintaining remote WordPress installations with
-    Capistrano.  Pulls in WordPress from SVN, optionally using a local or 
+    Capistrano.  Pulls in WordPress from SVN, optionally using a local or
     remote cache, and supports a number of common operations and tasks towards
-    the care and feeding of sites that may not be 100% maintained through 
+    the care and feeding of sites that may not be 100% maintained through
     version control.
   EOF
   gem.authors = ["Crowd Favorite"]

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.2

data/capistrano-wp.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "capistrano-wp"
-  s.version = "0.4.1"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Crowd Favorite"]
-  s.date = "2013-07-11"
-  s.description = "    Recipes for deploying and maintaining remote WordPress installations with\n    Capistrano.  Pulls in WordPress from SVN, optionally using a local or \n    remote cache, and supports a number of common operations and tasks towards\n    the care and feeding of sites that may not be 100% maintained through \n    version control.\n"
+  s.date = "2013-07-15"
+  s.description = "Recipes for deploying and maintaining remote WordPress installations with\nCapistrano.  Pulls in WordPress from SVN, optionally using a local or\nremote cache, and supports a number of common operations and tasks towards\nthe care and feeding of sites that may not be 100% maintained through\nversion control.\n"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -24,6 +24,11 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "capistrano-wp.gemspec",
+    "doc/examples/Capfile",
+    "doc/examples/config/deploy.rb",
+    "doc/examples/config/deploy/production.rb",
+    "doc/examples/config/deploy/staging.rb",
+    "doc/examples/config/staging-local-config.php",
     "lib/capistrano-wp.rb",
     "lib/capistrano/crowdfavorite/wordpress.rb",
     "lib/crowdfavorite.rb",
@@ -41,7 +46,7 @@ Gem::Specification.new do |s|
     "spec/support/capistrano.rb"
   ]
   s.homepage = "http://github.com/crowdfavorite/gem-capistrano-wp"
-  s.licenses = ["GPL"]
+  s.licenses = ["Apache License version 2"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.25"
   s.summary = "Crowd Favorite WordPress Capistrano recipes"

data/doc/examples/Capfile

@@ -0,0 +1,19 @@
+# Copyright 2012-2013 Crowd Favorite, Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'rubygems'
+require 'railsless-deploy'
+require 'crowdfavorite/wordpress'
+load 'config/deploy' # remove this line to skip loading any of the default tasks
+

data/doc/examples/config/deploy.rb

@@ -0,0 +1,38 @@
+# Copyright 2012-2013 Crowd Favorite, Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set :stages, %w(production staging)
+set :default_stage, "production"
+
+require "capistrano/ext/multistage"
+
+#=============================================================================
+# app details and WordPress requirements
+
+# tags/3.5.2, branches/3.5, trunk
+set :wordpress_version, "branches/3.5"
+set :application, "my_application"
+
+#=============================================================================
+# app source repository configuration
+
+set :scm, :git
+set :repository, "https://github.com/example/example-wp.git"
+set :git_enable_submodules, 1
+
+#=============================================================================
+# Housekeeping
+# clean up old releases on each deploy
+set :keep_releases, 5
+after "deploy:create_symlink", "deploy:cleanup"

data/doc/examples/config/deploy/production.rb

@@ -0,0 +1,81 @@
+# Copyright 2012-2013 Crowd Favorite, Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set :stage, "production"
+
+set :user, 'deployuser'
+set :use_sudo, false
+
+server '172.16.42.42', :app, :web, :primary => true
+server '172.16.42.43', :app, :web
+
+# Don't push code to this server with 'cap deploy'
+server '172.16.17.17', :db, :no_release => true
+
+set :base_dir, "/var/local/www/example"
+set :deploy_to, File.join(fetch(:base_dir))
+set :current_dir, "httpdocs"
+set(:wp_path) { File.join(release_path, "wp") }
+# :version_dir - where versions live, 'versions'
+# :shared_dir - where shared files (wordpress cache, et cetera) live, 'shared'
+
+# Deploy strategy - use :remote_cache when possible, but some servers need :copy
+#set :deploy_via, :remote_cache
+set :deploy_via, :remote_cache
+
+# Specify a git branch to deploy
+set :branch, fetch(:branch, "master")
+
+#=============================================================================
+# Files to link or copy into web root
+# Symlinks are symlinked in
+
+# wp_symlinks defaults to:
+#  "cache" => "wp-content/cache"
+#  "uploads" => "wp-content/uploads"
+#  "blogs.dir" => "wp-content/blogs.dir"
+#
+# To override, set the target to nil:
+#
+#set :wp_symlinks, [{
+#  "cache" => nil
+#}]
+#
+# Or add other files:
+#
+#set :wp_symlinks, [{
+#  "authcache" => "wp-content/authcache"
+#}]
+#
+# Configs are copied in, and default to:
+#  "db-config.php" => "/",
+#  "advanced-cache.php" => "wp-content/",
+#  "object-cache.php" => "wp-content/",
+#  "*.html" => "/",
+#
+# To override (like wp_symlinks):
+#set :wp_configs, [{
+#}]
+#
+# Stage-specific overrides are copied from the config directory,
+# like production-example.txt or staging-example.txt
+# Default list:
+#
+#       "local-config.php" => "local-config.php",
+#       ".htaccess" => ".htaccess"
+#
+# To override or add other files (as above, but note no []):
+#
+#set :stage_specific_overrides, {
+#}

data/doc/examples/config/deploy/staging.rb

@@ -0,0 +1,81 @@
+# Copyright 2012-2013 Crowd Favorite, Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set :stage, "staging"
+
+set :user, 'deployuser'
+set :use_sudo, false
+
+server '172.16.1.42', :app, :web, :primary => true
+server '172.16.1.43', :app, :web
+
+# Don't push code to this server with 'cap deploy'
+server '172.16.1.17', :db, :no_release => true
+
+set :base_dir, "/var/local/www/example-staging"
+set :deploy_to, File.join(fetch(:base_dir))
+set :current_dir, "httpdocs"
+set(:wp_path) { File.join(release_path, "wp") }
+# :version_dir - where versions live, 'versions'
+# :shared_dir - where shared files (wordpress cache, et cetera) live, 'shared'
+
+# Deploy strategy - use :remote_cache when possible, but some servers need :copy
+#set :deploy_via, :remote_cache
+set :deploy_via, :remote_cache
+
+# Specify a git branch to deploy
+set :branch, fetch(:branch, "develop")
+
+#=============================================================================
+# Files to link or copy into web root
+# Symlinks are symlinked in
+
+# wp_symlinks defaults to:
+#  "cache" => "wp-content/cache"
+#  "uploads" => "wp-content/uploads"
+#  "blogs.dir" => "wp-content/blogs.dir"
+#
+# To override, set the target to nil:
+#
+#set :wp_symlinks, [{
+#  "cache" => nil
+#}]
+#
+# Or add other files:
+#
+#set :wp_symlinks, [{
+#  "authcache" => "wp-content/authcache"
+#}]
+#
+# Configs are copied in, and default to:
+#  "db-config.php" => "/",
+#  "advanced-cache.php" => "wp-content/",
+#  "object-cache.php" => "wp-content/",
+#  "*.html" => "/",
+#
+# To override (like wp_symlinks):
+#set :wp_configs, [{
+#}]
+#
+# Stage-specific overrides are copied from the config directory,
+# like production-example.txt or staging-example.txt
+# Default list:
+#
+#       "local-config.php" => "local-config.php",
+#       ".htaccess" => ".htaccess"
+#
+# To override or add other files (as above, but note no []):
+#
+#set :stage_specific_overrides, {
+#}

data/doc/examples/config/staging-local-config.php

@@ -0,0 +1,28 @@
+<?php
+/* Copyright 2012-2013 Crowd Favorite, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+define("WP_HOME", 'http://example.dev');
+define("WP_SITEURL", 'http://example.dev/wp');
+define("WP_CONTENT_URL", 'http://example.dev/wp-content');
+define("WP_CONTENT_DIR",  dirname(__FILE__) . '/'. 'wp-content');
+
+define('DB_NAME', 'example_staging');
+define('DB_USER', 'example');
+define('DB_PASSWORD', 'correct-horse-battery-staple');
+define('DB_HOST', '172.16.1.17');
+
+define('WP_DEBUG', true);
+define('SCRIPT_DEBUG', true);

data/lib/capistrano-wp.rb

@@ -1,3 +1,17 @@
+# Copyright 2012-2013 Crowd Favorite, Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require 'rubygems'
 
 require 'crowdfavorite'

data/lib/capistrano/crowdfavorite/wordpress.rb

@@ -1,2 +1,16 @@
+# Copyright 2012-2013 Crowd Favorite, Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require 'crowdfavorite/wordpress'
 $stderr.puts " * capistrano/crowdfavorite/wordpress is deprecated - please require 'crowdfavorite/wordpress' instead"

data/lib/crowdfavorite.rb

@@ -1,3 +1,17 @@
+# Copyright 2012-2013 Crowd Favorite, Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require 'rubygems'
 
 module CrowdFavorite

data/lib/crowdfavorite/support/capistrano_extensions.rb

@@ -1,3 +1,17 @@
+# Copyright 2012-2013 Crowd Favorite, Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 require 'tempfile'
 
 # These methods are used by recap tasks to run commands and detect when files have changed