capistrano-maintenance 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4840f0379ec3fc55ca13c69663bfc4cd14132c76
-  data.tar.gz: 6fa9b428b819ad1619a86882820622857b41b420
+  metadata.gz: 25477cc88ca901a2e817c8af7a006b16a1f33b3d
+  data.tar.gz: bbd59d8cfb1b4e27ca887ee44b3cb5bf6df3a16a
 SHA512:
-  metadata.gz: 978014eaa1c344105af9f482b0e26894fecac52add57f45a12c9636138d5eba52357fed2398cb27bb410dfb18bd50aa6dbc98ce9cba21f06d54c96cfb344d31f
-  data.tar.gz: f24d03db3e71fe4416d5297df6ba6ae95af58136a1a1a0394fa7ff6a7cdd07a2d22f9d53392a2bb99742b52e07ff2167cca223a38604bc47a3f779cbfb746df0
+  metadata.gz: 5aa9f2219c5bedad52d41a5f89809335e4da43037cc2a14113a92d1588c390dca0fab6915b8ec33b8caaa5062cc3a9e0ef980d37a2261489522235f015882111
+  data.tar.gz: 608e2fcb177320e6bf7be54a8e8307afc26fac11e6d14f48fd4328b7ef35228fe09002c75c0e66a2d89f8063375e7f34c0908914538a243b36b7d68b7ebd4116

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# capistrano-maintenance changelog
+
+Reverse chronological order:
+
+## master
+
+https://github.com/capistrano/capistrano-maintenance/compare/v1.1.0...HEAD
+
+* Your contribution here!
+
+## `1.1.0` (2017-01-26)
+
+https://github.com/capistrano/capistrano-maintenance/compare/v1.0.0...v1.1.0
+
+* [#37](https://github.com/capistrano/maintenance/pull/37): Allow configuration of which roles show maintenance pages - [@lazyatom](https://github.com/lazyatom)
+
+## `1.0.0` (2015-05-06)
+
+* First stable release

data/README.md

@@ -4,17 +4,22 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'capistrano', '~> 3.0'
-    gem 'capistrano-maintenance', github: "capistrano/maintenance", require: false 
-
+``` ruby
+gem 'capistrano', '~> 3.0'
+gem 'capistrano-maintenance', '~> 1.0', require: false
+```
 
 And then execute:
 
-    $ bundle
+``` bash
+$ bundle
+```
 
 Or install it yourself:
 
-    $ gem install capistrano-maintenance
+``` bash
+$ gem install capistrano-maintenance
+```
 
 ## Usage
 
@@ -24,7 +29,7 @@ Application servers such as [Passenger](https://www.phusionpassenger.com) and [u
 
 Here is an example config for **nginx**. Note that this is just a part of the complete config, and will probably require modifications.
 
-```
+``` nginx
 error_page 503 @503;
 
 # Return a 503 error if the maintenance page exists.
@@ -46,7 +51,7 @@ location @503 {
 
 And here is an example config for **Apache**. This will also need to be modified.
 
-```
+``` apache
 # Create an alias to the maintenance page used as error document.
 Alias "/error" "/var/www/domain.com/shared/public/system/"
 ErrorDocument 503 /error/maintenance.html
@@ -64,12 +69,14 @@ RewriteRule ^/(.*)$ balancer://unicornserver%{REQUEST_URI} [P,QSA,L]
 
 You can now require the gem in your `Capfile`:
 
-    require 'capistrano/maintenance'
+```
+require 'capistrano/maintenance'
+```
 
 ### Enable task
 
-Present a maintenance page to visitors. Disables your application's web
-interface by writing a "#{maintenance_basename}.html" file to each web server. The
+Present a maintenance page to visitors. Disables your application's web interface
+by writing a `"#{maintenance_basename}.html"` file to each web server. The
 servers must be configured to detect the presence of this file, and if
 it is present, always display it instead of performing the request.
 
@@ -77,20 +84,65 @@ By default, the maintenance page will just say the site is down for
 "maintenance", and will be back "shortly", but you can customize the
 page by specifying the REASON and UNTIL environment variables:
 
-    cap maintenance:enable REASON="hardware upgrade" UNTIL="12pm Central Time"
+```
+cap maintenance:enable REASON="hardware upgrade" UNTIL="12pm Central Time"
+```
 
 You can use a different template for the maintenance page by setting the
-`:maintenance_template_path` variable in your deploy.rb file. The template file
-should either be a plaintext or an erb file.
+`:maintenance_template_path` variable in your deploy.rb file with an absolute path. 
+
+```
+set :maintenance_template_path, File.expand_path("../../app/path/to/maintenance.erb.html", __FILE__)
+```
+
+The template file should either be a plaintext or an erb file. For example:
+
+``` html
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Maintenance</title>
+    <style type="text/css">
+    body {
+        width: 400px;
+        margin: 100px auto;
+        font: 300 120% "OpenSans", "Helvetica Neue", "Helvetica", Arial, Verdana, sans-serif;
+    }
+
+    h1 {
+        font-weight: 300;
+    }
+    </style>
+</head>
+<body>
+    <h1>Maintenance</h1>
+
+    <p>The system is down for <%= reason ? reason : "maintenance" %><br>
+           as of <%= Time.now.strftime("%F %H:%M %Z") %>.</p>
+
+    <p>It'll be back <%= deadline ? deadline : "shortly" %>.</p>
+</body>
+</html>
+```
+
+By default, the maintenance page will be uploaded to all servers with the `web` role,
+but if your application has different needs, you can customize this using the
+`maintenance_roles` variable:
+
+```
+set :maintenance_roles, -> { roles([:web, :other_role]) }
+```
 
 Further customization will require that you write your own task.
 
 ### Disable task
 
-    cap maintenance:disable
+``` bash
+cap maintenance:disable
+```
 
 Makes the application web-accessible again. Removes the
-"#{maintenance_basename}.html" page generated by maintenance:disable, which (if your
+`"#{maintenance_basename}.html"` page generated by maintenance:disable, which (if your
 web servers are configured correctly) will make your application web-accessible again.
 
 ## Contributing
@@ -100,3 +152,9 @@ web servers are configured correctly) will make your application web-accessible
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Authors
+
+The original `capistrano-maintenance` gem was created by [Thomas von Deyen](https://github.com/tvdeyen) and the implementation for Capistrano 3 in this repo was written by [Kir Shatrov](https://github.com/kirs).
+
+As a Capistrano team, we thank Thomas for collaboration and providing the push access to the `capistrano-maintenance` gem.

data/lib/capistrano-maintenance/version.rb

@@ -1,3 +1,3 @@
 module CapistranoMaintenance
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/capistrano/tasks/maintenance.rake

@@ -1,7 +1,7 @@
 namespace :maintenance do
   desc "Turn on maintenance mode"
   task :enable do
-    on roles(:web) do
+    on fetch(:maintenance_roles, roles(:web)) do
       require 'erb'
 
       reason = ENV['REASON']
@@ -26,7 +26,7 @@ namespace :maintenance do
 
   desc "Turn off maintenance mode"
   task :disable do
-    on roles(:web) do
+    on fetch(:maintenance_roles, roles(:web)) do
       execute "rm -f #{shared_path}/public/system/#{fetch(:maintenance_basename, 'maintenance')}.html"
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-maintenance
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kir Shatrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-06 00:00:00.000000000 Z
+date: 2017-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -89,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Enable and disabled tasks to show when your project is on maintenance