california 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9adb6fd666b3eabfd3b9bd6c4da5dd419c3f06b5
-  data.tar.gz: ff63ffad385ad07dd09c421c05babc3140aa44e6
+  metadata.gz: 8bfdd67a9f3ee5fdd0b596fd1167067e0077a5ac
+  data.tar.gz: 2222a88579562b1b19b3c6198129ad22ce21e8f4
 SHA512:
-  metadata.gz: dd60f30690bc3442ce3ad810c5df6295c69ed69cc89410d69f80d73f17abb18d816078d08cbddf510694fd33167858004aa5847cf4c7cae5506e90a4bc54958d
-  data.tar.gz: fd9fbae30bdcce5eb55436f738634d759cf9a66aa34a47a869f1daabad874af6ab7b134ec4c96788b2ad9017a08082aca6819c3b4f5067f132a3405e3b0c2359
+  metadata.gz: 8b7a2a7ff7f4271948d4233bec61225651493c33e66267669c9ee83d02667085309536ecfcf5fa1214a109b8c4d39353ea8b64e7ad4dc2c1417ec78cc3dab214
+  data.tar.gz: 42ce9ca509167b5cd4c0f1a98a337d3341a217cab2d840ae4ab903ed70d9618babef041e5f5337f88a7cd3991f233fe15798dfa9ca13fb53e763f5f8bdf4efa9

data/LICENSE.md

@@ -1,4 +1,6 @@
-Copyright 2015 halo
+Copyright (c) 2018 halo https://github.com/halo/california
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,7 +1,22 @@
-## Opinionated capistrano deployment for dummies Edit
+## Opinionated Capistrano deployment for dummies
 
+[![Version](https://img.shields.io/gem/v/california.svg?style=flat)](https://rubygems.org/gems/california)
 [![Build Status](https://travis-ci.org/halo/california.svg?branch=master)](https://travis-ci.org/halo/california)
 
+When using [Capistrano](https://github.com/capistrano/capistrano) to deploy an application to a server, it runs [all this stuff](https://github.com/capistrano/capistrano/blob/master/lib/capistrano/tasks/deploy.rake) creating a new symlink for every release, cleans up old ones, etc..
+
+California is an opinionated out-of-the-box, best-practice configuration that aims to make things a little bit simpler for both beginners and advanced users.
+
+### Design Goals
+
+* Don't separate releases in different directories. Just [perform a simple checkout](https://github.com/halo/california/blob/master/lib/california/capistrano/tasks/deploy.rake#L21-L24) that updates the code in place.
+
+* Introduce convention over configuration, e.g. as to [where the applications are deployed](https://github.com/halo/california/blob/master/lib/california/stage.rb#L40-L42).
+
+* Every app has its own user on the server and when running commands during deploy, [load the `.bash_profile` of that user](https://github.com/halo/california/blob/master/lib/california/stage.rb#L65-L67)
+
+* Nicer logging output so that you *really* know at which stage of the deploy you are (update code, run bundler, restart)
+
 ### Requirements
 
 * Ruby >= 2.0
@@ -15,7 +30,7 @@ Create a new repository with a Gemfile like this and run `bundle install` to get
 # Content of Gemfile
 source 'https://rubygems.org'
 
-gem 'california', github: 'halo/california'
+gem 'california'
 ```
 
 Then run the generator for creating your first app you may want to deploy.
@@ -26,17 +41,18 @@ Let's say the name of the app is "hello_world".
 bundle exec california generate hello_world
 ```
 
-Modify `hello_world/deploy/production.rb` (or whichever stages you have) and define which servers you want to deploy to.
+Follow the instructions in `hello_world/deploy/production.rb` (or whichever stages you have) and define which servers you want to deploy to.
 
 ### Server preparation
 
-When deploying your `hello_world` app, it is assumed that you can ssh into the server with the user `hello_world` and that the repository has been cloned to `/mnt/apps/hello_world/repository`.
+When deploying your `hello_world` app, it is assumed that you can ssh into the server with the username `hello_world` and that the repository has been cloned to `/mnt/apps/hello_world/repository`.
+
+The reason for this directory is that if you are on AWS, `/mnt` is the default path for permanent storage. If you're not on AWS, you may just ride along and follow the convention.
 
-Any additional environment variables needed to configure your application should be located in a file called `/mnt/envs/hello_world`.
+If you configure your application via environment variables, you can add them in a file called `/mnt/envs/hello_world`.
 
 ```bash
 # Example of content of /mnt/envs/hello_world
-SECRET_TOKEN="abcdef"
 DATABASE_URL="postgres://db.example.com"
 ```
 
@@ -54,4 +70,4 @@ bundle exec cap production deploy migrate=true
 
 ### Copyright
 
-MIT 2016 halo. See [MIT-LICENSE](http://github.com/halo/california/blob/master/MIT-LICENSE).
+MIT 2018 halo. See [LICENSE.md](http://github.com/halo/california/blob/master/LICENSE.md).

data/lib/california/capistrano/tasks/deploy.rake

@@ -57,15 +57,19 @@ namespace :deploy do
   # –––––––––––––––
 
   task :updated do
-    logger.info 'Running Bundler...'
-
-    on roles :app do
-      as fetch(:application) do
-        within fetch(:deploy_to) do
-
-          # Running Bundler.
-          core_count = capture(:nproc).chomp
-          execute :bundle, :install, '--deployment', '--quiet', '--without', 'development', 'test', '--jobs', core_count
+    if fetch(:skip_bundler)
+      logger.info 'Skipping Bundler...'
+    else
+      logger.info 'Running Bundler...'
+
+      on roles :app do
+        as fetch(:application) do
+          within fetch(:deploy_to) do
+
+            # Running Bundler.
+            core_count = capture(:nproc).chomp
+            execute :bundle, :install, '--deployment', '--quiet', '--without', 'development', 'test', '--jobs', core_count
+          end
         end
       end
     end
@@ -76,13 +80,23 @@ namespace :deploy do
   # ––––––––––––––––––
 
   task :publishing do
-    logger.info 'Restarting the app...'
-
-    on roles :app do
-      as fetch(:application) do
-        within File.join(fetch(:deploy_to), 'tmp') do
-
-          execute :touch, 'restart.txt'
+    if fetch(:skip_restart)
+      logger.info 'Skipping Restart...'
+    else
+
+      on roles :app do
+        as fetch(:application) do
+
+          if fetch(:restart_strategy) == 'restart.txt'
+            logger.info 'Restarting the app via restart.txt...'
+            within File.join(fetch(:deploy_to), 'tmp') do
+              execute :touch, 'restart.txt'
+            end
+
+          else
+            logger.info 'Restarting the app via passenger-config...'
+            execute 'passenger-config', 'restart-app', fetch(:deploy_to)
+          end
         end
       end
     end

data/lib/california/stage.rb

@@ -1,4 +1,4 @@
-module BenderLogger
+module CaliforniaLogger
   def self.logger
     @logger ||= logger!
   end
@@ -15,7 +15,7 @@ module BenderLogger
 end
 
 def logger
-  BenderLogger.logger
+  CaliforniaLogger.logger
 end
 
 # Rails environment sanity check.

data/lib/california/templates/app/config/deploy/stage.rb

@@ -1,17 +1,30 @@
-# The stage name is derived from this very filename,
-# which should include "production", "staging", or "test" in its name.
+# First we need to set a stage name.
+# This is usually an environment such as `production`, `staging`, or `test`.
+# By default, the stage name is derived from the filename of THIS file.
 set :stage, File.basename(__FILE__, '.rb')
 
-# Loading task defaults.
-load 'california/stage'
+# By default, we will run `bundle install`, to skip that, uncomment the following line.
+# This is useful for non-ruby applications.
+# set :skip_bundler, true
 
-# You need to define at least one server.
-# The one with the role "migrator" will be entitled to run migrations:
-# server '203.0.113.19', roles: %w{ all app web_server migrator }
+# By default the webserver is restarted using `/usr/bin/passenger-config`.
+# If you prefer the old-fashioned `touch tmp/restart.txt` uncomment the following line.
+# set :restart_strategy, 'restart.txt'
 
-# You may also set any custom Capistrano options:
+# You can skip the restart alltogether by uncommenting the following line.
+# set :skip_restart, true
+
+# You may also set any custom Capistrano options if you wish:
 # set :ssh_options, {
 #   forward_agent: true,
 #   port: 12345,
 #   keys: Pathname.new('~/.ssh/mykey').expand_path.to_s,
 # }
+
+# That's all for custom configuration. Now we can load the default configuration.
+load 'california/stage'
+
+# Important: Now you need to define AT LEAST ONE server.
+
+# Example: The one with the role "migrator" will be entitled to run migrations:
+# server '203.0.113.19', roles: %w{ all app web_server migrator }

data/lib/california/version.rb

@@ -1,3 +1,3 @@
 module California
-  VERSION = '0.4.1'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: california
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - halo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2018-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -16,30 +16,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,7 +115,8 @@ files:
 - lib/california/templates/app/config/deploy/stage.rb
 - lib/california/version.rb
 homepage: https://github.com/halo/california
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -133,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Capistrano 3 for dummies.