wp-capistrano 0.0.0 → 0.1.0

data/README.rdoc

@@ -1,16 +1,49 @@
 = wp-capistrano
 
+Capistrano receipe for WordPress
+
 == Usage
 
 A sample Capfile and config.yml exist in lib/wp_generate/templates/capify.
 
-Those should be copied into wp-content/Capfile and wp-content/lib/config.yml respectively.
+Those should be copied into wp-content/Capfile and wp-content/lib/config.yml respectively. Things you'll need to change in config.yml include:
+
+- application.repository -> set that to the repository that includes the contents of wp-content
+- wordpress.repository -> in the sample this is set to our mirror on GitHub, but you may prefer to mirror that locally or set up your own
+- wordpress.version -> a git tree-ish, which can be a branch name, tag, or a commit hash (e.g. v2.9.2)
+- deploy.* -> these names are used when doing cap deploy when deploying to non-default environments (i.e. cap production deploy)
+- deploy.*.ssh_user -> the user who will log into the machine, if omitted will use the default
+- deploy.*.ssh_domain -> the host to be SSHed into
+- deploy.*.path -> the path on the remote machine
+- deploy.*.vhost -> the intended host name when being viewed on the remote machine
+- deploy.*.database.*
 
-For the initial run, you should first create the directory specified in deploy.*.path on the server, then run:
+For the initial run, you should first create the directory specified in deploy.*.path on the server, or at least make sure it's possible for the deploy user to create it, then run:
 
  cap setup:wordpress
 
-This will 
+This will create the Capistrano structure, check out the specified version of WordPress, create a shared directory full of things like wp-config.php and uploads. Now go and edit wp-config.php on the server, unless you specified the database password in config.yml. Then to deploy your wp-content, run:
+
+ cap deploy
+
+If you've set up Apache correctly (a .htaccess will be created, but that's all the help it will give you), you can visit the vhost you specified and everything should be working.
+
+When you update things, don't forget to push wp-content (and any submodules), and:
+
+ cap deploy
+
+And to setup/deploy to hosts other than the default, use:
+
+ cap staging deploy
+ cap production deploy
+
+== Additional features
+
+=== SASS
+
+If there exists wp-content/themes/*/*/sass_output.php it will be executed (from that directory) and its contents will be placed in sass_output.css. Then ../style.css will be sedded to s/\.php/\.css/, and both will be uploaded to the appropriate places.
+
+sass_output.php can be found in wp-generate's theme generator. It is very handy for development, but less server load is more good, so we "cache" it in this way.
 
 == wp-generate
 

data/Rakefile

@@ -4,7 +4,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "wp-capistrano"
-    gem.summary = %Q{Capistrano receipe bits for WordPress}
+    gem.summary = %Q{Capistrano receipe for WordPress}
     gem.description = %Q{}
     gem.email = "tom@thedextrousweb.com"
     gem.homepage = "http://github.com/dxw/wp-capistrano"

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - The Dextrous Web
@@ -27,6 +27,7 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- README.rdoc
 - Rakefile
 - VERSION
 - lib/wp_capistrano/deploy.rb
@@ -38,7 +39,6 @@ files:
 - lib/wp_generate/generator/capify.rb
 - lib/wp_generate/templates/capify/Capfile
 - lib/wp_generate/templates/capify/config.yml
-- README.rdoc
 has_rdoc: true
 homepage: http://github.com/dxw/wp-capistrano
 licenses: []
@@ -68,6 +68,6 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Capistrano receipe bits for WordPress
+summary: Capistrano receipe for WordPress
 test_files: []