capistrano-forkcms 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3318d335c4f055d87e7fd6a0211ce0b0c995442d
-  data.tar.gz: 827d06b0ffbd892cc57559a9c06c8ca7135133f2
+  metadata.gz: f3bb3f838a9decc5e3f5abb35a9be070cb29ec62
+  data.tar.gz: b50cb4edf7b9bad52d0b59084051094a6eac517e
 SHA512:
-  metadata.gz: 9e5eed958554b121bedc91beb491ea3ad4ed0fa1abacb25da318110fa9f81e1d8f5f72cb47a671dbe610e2e592d345bc6cfa6d577626f882b9995c931676e407
-  data.tar.gz: f19d32a20f0dc3da17bc1f25a270e5cec654981ebc578acb0545c9ffc2ad75b24e5be7862f8260c57db07436ea2ae01909b290b567ac649d73c1201ffd146641
+  metadata.gz: 3735442b1fcc2b7219871c836528c842552eb511947c79279c694153a574881a6603dcd91cabba43c72e0fc293bf64fd099da958548ca3b8f2bef115a926b6ee
+  data.tar.gz: d8c1560817561229a24bf24d87fc476eb6d2e3f08f047acc7922678516d3354fb489c4c7cb39dc75cc59794541a97d0a4db137afa3e0b62b8c08709a33810a7e

data/README.md

@@ -1,8 +1,9 @@
 # Capistrano::Forkcms
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/capistrano/forkcms`. To experiment with that code, run `bin/console` for an interactive prompt.
+Fork CMS specific Capistrano tasks
+
+Capistrano ForkCMS - Easy deployment of ForkCMS 5+ apps with Ruby over SSH.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -16,26 +17,69 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install capistrano-forkcms
 
 ## Usage
 
-TODO: Write usage instructions here
+Require the module in your Capfile:
+
+    require "capistrano/forkcms"
+    
+The plugin comes with two tasks:
+
+* `forkcms:configure:composer`, which will configure the `capistrano/composer` plugin.
+* `forkcms:symlink:document_root`, which will link the document_root to the current-folder. 
+
+But you won't need any of them as everything is wired automagically.
+
+
+## Configuration
+
+Configuration options:
+
+* `:php_bin_custom_path`, this will allow you to configure a custom PHP binary, the fallback is `php`.
+  
+
+## How to use with a fresh Fork install
+
+1. Create a Capfile with the content below:
 
-## Development
+    # Load DSL and set up stages
+    require "capistrano/setup"
 
-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.
+    # Include default deployment tasks
+    require "capistrano/deploy"
 
-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).
+    require "capistrano/scm/git"
+    install_plugin Capistrano::SCM::Git
+
+    require "capistrano/forkcms"
+
+    # Load custom tasks from `lib/capistrano/tasks` if you have any defined
+    Dir.glob("lib/capistrano/tasks/*.rake").each { |r| import r }
+
+2. Create a file called `config/deploy.rb`, with the content below:
+
+    set :application, "$your-application-name"
+    set :repo_url, "$your-repo-url"
+
+    set :keep_releases, 3
+
+3. Create a file called `config/deploy/production.rb`, with the content below:
+
+    ... @todo, fix this
+
+4. Create a file called `config/deploy/staging.rb`, with the content below:
+
+    server "$your-server-hostname", user: "sites", roles: %w{app db web}
+    set :deploy_to, "$your-path-where-everything-should-be-deployed"
+    set :document_root, "$your-document-root"
+    
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capistrano-forkcms.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/tijsverkoyen/capistrano-forkcms](https://github.com/tijsverkoyen/capistrano-forkcms).
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/capistrano-forkcms.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Fork CMS specific Capistrano tasks}
   spec.description   = %q{Capistrano ForkCMS - Easy deployment of ForkCMS 5+ apps with Ruby over SSH}
-  spec.homepage      = "https://github.com/tijsverkoyen/capistrano-fork"
+  spec.homepage      = "https://github.com/tijsverkoyen/capistrano-forkcms"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/capistrano/forkcms/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Forkcms
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-forkcms
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tijs Verkoyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,7 +101,7 @@ files:
 - lib/capistrano/forkcms/defaults.rb
 - lib/capistrano/forkcms/version.rb
 - lib/capistrano/tasks/forkcms.rake
-homepage: https://github.com/tijsverkoyen/capistrano-fork
+homepage: https://github.com/tijsverkoyen/capistrano-forkcms
 licenses:
 - MIT
 metadata: {}