capistrano 3.4.0 → 3.17.1

data/CONTRIBUTING.md

@@ -1,93 +1,63 @@
-## CONTRIBUTING
-
-**The issue tracker is intended exclusively for things that are genuine bugs,
-or improvements to the code.**
-
-If you have a user support query, or you suspect that you might just be holding
-it wrong, drop us a line at [the mailing list](https://groups.google.com/forum/#!forum/capistrano), [StackOverflow](http://stackoverflow.com/questions/tagged/capistrano) or at [CodersClan](http://codersclan.net/?repo_id=325&source=contributing). The
-mailing list is moderated to cut down on spam, so please be patient, if you use
-StackOverflow, make sure to tag your post with "Capistrano". (Not forgetting
-any other tags which might relate, rvm, rbenv, Ubuntu, etc.)
-
-If you have an urgent problem you can use [CodersClan](http://codersclan.net/?repo_id=325&source=contributing) to solve your problem quickly. CodersClan has a community of Capistrano experts dedicated to solve code problems for bounties.
-
-Wherever you post please be sure to include the version of Capistrano you are
-using, which versions of any plugins (*capistrano-rvm*, *capistrano-bundler*,
-etc.). Proper logs are vital, if you need to redact them, go ahead, but be
-careful not to remove anything important. Please take care to format logs and
-code correctly, ideally wrapped to a sane line length, and in a mono spaced
-font. This all helps us to gather a clear understanding of what is going wrong.
-
-**If you really think that you found a bug, or want to enquire about a feature,
-or send us a patch to add a feature, or fix a bug, please keep a few things in
-mind:**
-
-## When Submitting An Issue:
-
-If you think there's a bug, please make sure it's really a bug in Capistrano.
-As Capistrano sits on the (sometimes rough) edges between SSH, Git, the
-network, Ruby, RVM, rbenv, chruby, Bundler, your Linux distribution, countless
-shell configuration files on your end, and the server… there's a good chance
-the problem lies somewhere else.
-
-Please make sure you have reviewed the FAQs at http://www.capistranorb.com/.
-
-It's really important to include as much information as possible, versions of
-everything involved, anything weird you might be doing that might be having
-side effects, include as much as you can in a [GitHub
-Gist](https://gist.github.com/) and link that from the issue, with tools such
-as Gist, we can link to individual lines and help work out what is going wrong.
-
-If you are an experienced Ruby programmer, take a few minutes to get our test
-suite running, and do what you can to get a test case written that fails, from
-there we can understand exactly what it takes to reproduce the issue (as it's
-documented with code)
-
-## When Requesting a Feature:
-
-We can't make everyone happy all of the time, and we've been around the block
-well enough to know when something doesn't work well, or when your proposed fix
-might impact other things.
-
-We prefer to [start with
-"no"](https://gettingreal.37signals.com/ch05_Start_With_No.php), and help you
-find a better way to solve your problem, sometimes the solution is to [build
-faster
-horses](http://blog.cauvin.org/2010/07/henry-fords-faster-horse-quote.html),
-sometimes the solution is to work around it in a neat way that you didn't know
-existed.
-
-Please don't be offended if we say no, and don't be afraid to fight your
-corner, try and avoid being one of the [poisonous
-people](https://www.youtube.com/watch?v=Q52kFL8zVoM)
-
-## Submitting A Pull Request:
-
-Pull requests are awesome, and if they arrive with decent tests, and conform to
-the guidelines below, we'll merge them in as soon as possible, we'll let you
-know which release we're planning them for (we adhere to
-[semver](http://semver.org/) so please don't be upset if we plan your changes
-for a later release)
-
- * The code is MIT licenced, your code will fall under the same license if we merge it.
- * We can't merge it without a [good commit
-   message](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message).
-   If you do this right, Github will use the commit message as the body of your
-   pull request, double win.
- * If you are referencing an improvement to an existing issue (if we have not
-   yet merged it )
- * Add an entry to the `CHANGELOG` under the `### master` section, but please
-   don't mess with the version.
- * If you add a new feature, please make sure to document it, open a
-   corresponding pull request in [the
-   documentation](https://github.com/capistrano/documentation) and mention the
-   code change pull request over there, and Github will link everything up. If
-   it's a simple feature, or a new variable, or something changed, it may be
-   appropriate simply to document it in the generated `Capfile` or `deploy.rb`, or
-   in the `README`
- * Take care to squash your commit into one single commit with a good message, it
-   saves us a lot of work in maintaining the CHANGELOG if we can generate it from
-   the commit messages between the release tags!
- * Tests! It's tricky to test some parts of Capistrano, but do your best, it
-   might just serve as a starting point for us to build a reliable test on top of,
-   and help us understand where you are coming from.
+**Hello and welcome!** Please look over this document before opening an issue or submitting a pull request to Capistrano.
+
+* [If you’re looking for help or have a question](#if-youre-looking-for-help-or-have-a-question)
+* [Reporting bugs](#reporting-bugs)
+* [Requesting new features or improvements](#requesting-new-features-or-improvements)
+* [Contributing code or documentation](#contributing-code-or-documentation)
+
+## If you’re looking for help or have a question
+
+**Check [Stack Overflow](http://stackoverflow.com/questions/tagged/capistrano) first if you need help using Capistrano.** You are more likely to get a quick response at Stack Overflow for common Capistrano topics. Make sure to tag your post with `capistrano` and/or `capistrano3` (not forgetting any other tags which might relate: rvm, rbenv, Ubuntu, etc.)
+
+If you have an urgent problem you can also try [CodersClan](http://codersclan.net/?repo_id=325&source=contributing), which has a community of Capistrano experts dedicated to solve code problems for bounties.
+
+When posting to Stack Overflow or CodersClan, be sure to include relevant information:
+
+* Capistrano version
+* Plugins and versions (capistrano-rvm, capistrano-bundler, etc.)
+* Logs and backtraces
+
+If you think you’ve found a bug in Capistrano itself, then…
+
+## Reporting bugs
+
+As much the Capistrano community tries to write good, well-tested code, bugs still happen. Sorry about that!
+
+**In case you’ve run across an already-known issue, check the FAQs first on the [official Capistrano site](http://capistranorb.com).**
+
+When opening a bug report, please include the output of the `cap <stage> doctor` task, e.g.:
+
+```
+cap production doctor
+```
+
+Also include in your report:
+
+* Versions of Ruby, Capistrano, and any plugins you’re using (if `doctor` didn't already do this for you)
+* A description of the troubleshooting steps you’ve taken
+* Logs and backtraces
+* Sections of your `deploy.rb` that may be relevant
+* Any other unique aspects of your environment
+
+If you are an experienced Ruby programmer, take a few minutes to get the Capistrano test suite running (see [DEVELOPMENT.md][]), and do what you can to get a test case written that fails. *This will be a huge help!*
+
+If you think you may have discovered a security vulnerability in Capistrano, do not open a GitHub issue. Instead, please send a report to <security@capistranorb.com>.
+
+## Requesting new features or improvements
+
+Capistrano continues to improve thanks to people like you! Feel free to open a GitHub issue for any or all of these ideas:
+
+* New features that would make Capistrano even better
+* Areas where documentation could be improved
+* Ways to improve developer happiness
+
+Generally speaking the maintainers are very conservative about adding new features, and we can’t guarantee that the community will agree with or implement your idea. Please don’t be offended if we say no! The Capistrano team will do our best to review all suggestions and at least weigh in with a comment or suggest a workaround, if applicable.
+
+**Your idea will have a much better chance of becoming reality if you contribute code for it (even if the code is incomplete!).**
+
+## Contributing code or documentation
+
+So you want to contribute to Capistrano? Awesome! We have a whole separate document just you. It explains our pull request workflow and walks you through setting up the development environment: [DEVELOPMENT.md][].
+
+
+[DEVELOPMENT.md]: https://github.com/capistrano/capistrano/blob/master/DEVELOPMENT.md

data/DEVELOPMENT.md

@@ -0,0 +1,127 @@
+Thanks for helping build Capistrano! Here are the development practices followed by our community.
+
+* [Who can help](#who-can-help)
+* [Contributing documentation](#contributing-documentation)
+* [Setting up your development environment](#setting-up-your-development-environment)
+* [Coding guidelines](#coding-guidelines)
+* [Submitting a pull request](#submitting-a-pull-request)
+* [Managing GitHub issues](#managing-github-issues)
+* [Reviewing and merging pull requests](#reviewing-and-merging-pull-requests)
+
+## Who can help
+
+Everyone can help improve Capistrano. There are ways to contribute even if you aren’t a Ruby programmer. Here’s what you can do to help the project:
+
+* adding to or fixing typos/quality in documentation
+* adding failing tests for reported bugs
+* writing code (no contribution is too small!)
+* reviewing pull requests and suggesting improvements
+* reporting bugs or suggesting new features (see [CONTRIBUTING.md][])
+
+## Contributing documentation
+
+Improvements and additions to Capistrano's documentation are very much appreciated. The official documention is stored in the `docs/` directory as Markdown files. These files are used to automatically generate the [capistranorb.com](http://capistranorb.com/) website, which is hosted by GitHub Pages. Feel free to make changes to this documentation as you see fit. Before opening a pull request, make sure your documentation renders correctly by previewing the website in your local environment. Refer to [docs/README.md][] for instructions.
+
+## Setting up your development environment
+
+Capistrano is a Ruby project, so we expect you to have a functioning Ruby environment. To hack on Capistrano you will further need some specialized tools to run its test suite.
+
+Make sure to install:
+
+* [Bundler](https://bundler.io/)
+* [Vagrant](https://www.vagrantup.com/)
+* [VirtualBox](https://www.virtualbox.org/wiki/Downloads) (or another [Vagrant-supported](https://docs.vagrantup.com/v2/getting-started/providers.html) VM host)
+
+
+### Running tests
+
+Capistrano has two test suites: an RSpec suite and a Cucumber suite. The RSpec suite handles quick feedback unit specs. The Cucumber suite is an integration suite that uses Vagrant to deploy to a real virtual server.
+
+```
+# Ensure all dependencies are installed
+$ bundle install
+
+# Run the RSpec suite
+$ bundle exec rake spec
+
+# Run the Cucumber suite
+$ bundle exec rake features
+
+# Run the Cucumber suite and leave the VM running (faster for subsequent runs)
+$ bundle exec rake features KEEP_RUNNING=1
+```
+
+### Report failing Cucumber features!
+
+Currently, the Capistrano CI build does *not* run the Cucumber suite. This means it is possible for a failing Cucumber feature to sneak in without being noticed by our continuous integration checks.
+
+**If you come across a failing Cucumber feature, this is a bug.** Please report it by opening a GitHub issue. Or even better: do your best to fix the feature and submit a pull request!
+
+## Coding guidelines
+
+This project uses [RuboCop](https://github.com/bbatsov/rubocop) to enforce standard Ruby coding guidelines.
+
+* Test that your contributions pass with `rake rubocop`
+* Rubocop is also run as part of the full test suite with `rake`
+* Note the CI build will fail and your PR cannot be merged if Rubocop finds errors
+
+## Submitting a pull request
+
+Pull requests are awesome, and if they arrive with decent tests, and conform to the guidelines below, we'll merge them in as soon as possible, we'll let you know which release we're planning them for (we adhere to [semver](http://semver.org/) so please don't be upset if we plan your changes for a later release).
+
+Your code should conform to these guidelines:
+
+ * The code is MIT licensed, your code will fall under the same license if we merge it.
+ * We can't merge it without a [good commit message](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message). If you do this right, Github will use the commit message as the body of your pull request, double win.
+ * If you are making an improvement/fix for an existing issue, make sure to mention the issue number (if we have not yet merged it )
+ * Add an entry to the `CHANGELOG` under the `### master` section, but please don't mess with the version.
+ * If you add a new feature, please make sure to document it by modifying the appropriate Markdown files in `docs/` (see [contributing documentation](#contributing-documentation), above). If it's a simple feature, or a new variable, or something changed, it may be appropriate simply to document it in the generated `Capfile` or `deploy.rb`, or in the `README`.
+ * Take care to squash your commit into one single commit with a good message, it saves us a lot of work in maintaining the CHANGELOG if we can generate it from the commit messages between the release tags!
+ * Tests! It's tricky to test some parts of Capistrano, but do your best, it might just serve as a starting point for us to build a reliable test on top of, and help us understand where you are coming from.
+
+## Managing GitHub issues
+
+The Capistrano maintainers will do our best to review all GitHub issues. Here’s how we manage issues:
+
+1. Issues will be acknowledged with an appropriate label (see below).
+2. Issues that are duplicates, spam, or irrelevant (e.g. wrong project), or are questions better suited for Stack Overflow (see [CONTRIBUTING.md][]) will be closed.
+3. Once an issue is fixed or resolved in an upcoming Capistrano release, it will be closed and assigned to a GitHub milestone for that upcoming version number.
+
+The maintainers do not have time to fix every issue ourselves, but we will gladly accept pull requests, especially for issues labeled as "you can help" (see below).
+
+### Issue labels
+
+Capistrano uses these GitHub labels to categorize issues:
+
+* **bug?** – Could be a bug (not reproducible or might be user error)
+* **confirmed bug** – Definitely a bug
+* **new feature** – A request for Capistrano to add a feature or work differently
+* **chore** – A TODO that is neither a bug nor a feature (e.g. improve docs, CI infrastructure, etc.)
+
+Also, the Capistrano team will sometimes add these labels to facilitate communication and encourage community feedback:
+
+* **discuss!** – The Capistrano team wants more feedback from the community on this issue; e.g. how a new feature should work, or whether a bug is serious or not.
+* **you can help!** – We want the community to help by submitting a pull request to solve a bug or add a feature. If you are looking for ways to contribute to Capistrano, start here!
+* **needs more info** – We need more info from the person who opened the issue; e.g. steps to reproduce a bug, clarification on a desired feature, etc.
+
+*These labels were inspired by Daniel Doubrovkine’s [2014 Golden Gate Ruby Conference talk](http://confreaks.tv/videos/gogaruco2014-taking-over-someone-else-s-open-source-projects).*
+
+## Reviewing and merging pull requests
+
+Pull requests and issues follow similar workflows. Before merging a pull request, the Capistrano maintainers will check that these requirements are met:
+
+* All CI checks pass
+* Significant changes in behavior or fixes mentioned in the CHANGELOG
+* Clean commit history
+* New features are documented
+* Code changes/additions are tested
+
+If any of these are missing, the **needs more info** label is assigned to the pull request to indicate the PR is incomplete.
+
+Merging a pull request is a decision entrusted to the maintainers of the Capistrano project. Any maintainer is free to merge a pull request if they feel the PR meets the above requirements and is in the best interest of the Capistrano community.
+
+After a pull request is merged, it is assigned to a GitHub milestone for the upcoming version number.
+
+
+[CONTRIBUTING.md]: https://github.com/capistrano/capistrano/blob/master/CONTRIBUTING.md
+[docs/README.md]: https://github.com/capistrano/capistrano/blob/master/docs/README.md

data/Dangerfile

@@ -0,0 +1 @@
+danger.import_dangerfile(github: "capistrano/danger", branch: "no-changelog")

data/Gemfile

@@ -1,9 +1,46 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in capistrano.gemspec
 gemspec
 
+gem "mocha"
+gem "rspec"
+gem "rspec-core", "~> 3.4.4"
+
 group :cucumber do
-  gem 'cucumber'
-  gem 'rspec', '~> 3.0.0'
+  # Latest versions of cucumber don't support Ruby < 2.1
+  # rubocop:disable Bundler/DuplicatedGem
+  if Gem::Requirement.new("< 2.1").satisfied_by?(Gem::Version.new(RUBY_VERSION))
+    gem "cucumber", "< 3.0.1"
+  else
+    gem "cucumber"
+  end
+  # rubocop:enable Bundler/DuplicatedGem
+end
+
+# Latest versions of net-ssh don't support Ruby < 2.2.6
+if Gem::Requirement.new("< 2.2.6").satisfied_by?(Gem::Version.new(RUBY_VERSION))
+  gem "net-ssh", "< 5.0.0"
+end
+
+# Latest versions of public_suffix don't support Ruby < 2.1
+if Gem::Requirement.new("< 2.1").satisfied_by?(Gem::Version.new(RUBY_VERSION))
+  gem "public_suffix", "< 3.0.0"
+end
+
+# Latest versions of i18n don't support Ruby < 2.4
+if Gem::Requirement.new("< 2.4").satisfied_by?(Gem::Version.new(RUBY_VERSION))
+  gem "i18n", "< 1.3.0"
+end
+
+# Latest versions of rake don't support Ruby < 2.2
+if Gem::Requirement.new("< 2.2").satisfied_by?(Gem::Version.new(RUBY_VERSION))
+  gem "rake", "< 13.0.0"
+end
+
+# We only run danger and rubocop on a new-ish ruby; no need to install them otherwise
+if Gem::Requirement.new("> 2.4").satisfied_by?(Gem::Version.new(RUBY_VERSION))
+  gem "danger"
+  gem "psych", "< 4" # Ensures rubocop works on Ruby 3.1
+  gem "rubocop", "0.48.1"
 end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License (MIT)
 
-Copyright (c) 2012-2013 Tom Clements, Lee Hambley
+Copyright (c) 2012-2020 Tom Clements, Lee Hambley
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,48 +1,131 @@
-# Capistrano [![Build Status](https://travis-ci.org/capistrano/capistrano.svg?branch=master)](https://travis-ci.org/capistrano/capistrano) [![Code Climate](http://img.shields.io/codeclimate/github/capistrano/capistrano.svg)](https://codeclimate.com/github/capistrano/capistrano) <a href="http://codersclan.net/?repo_id=325&source=small"><img src="http://img.shields.io/badge/get-support-blue.svg"></a>
 
-## Documentation
+# Capistrano: A deployment automation tool built on Ruby, Rake, and SSH.
 
-Check out the [online documentation](http://capistranorb.com) of Capistrano 3 hosted via this [repository](https://github.com/capistrano/capistrano.github.io).
+[![Gem Version](https://badge.fury.io/rb/capistrano.svg)](http://badge.fury.io/rb/capistrano) [![Build Status](https://circleci.com/gh/capistrano/capistrano/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/capistrano/capistrano?branch=master) [![Code Climate](https://codeclimate.com/github/capistrano/capistrano/badges/gpa.svg)](https://codeclimate.com/github/capistrano/capistrano) [![CodersClan](https://img.shields.io/badge/get-support-blue.svg)](http://codersclan.net/?repo_id=325&source=small)
 
-## Support
+Capistrano is a framework for building automated deployment scripts. Although Capistrano itself is written in Ruby, it can easily be used to deploy projects of any language or framework, be it Rails, Java, or PHP.
 
-Need help with getting Capistrano up and running? Got a code problem you want to get solved quickly?
+Once installed, Capistrano gives you a `cap` tool to perform your deployments from the comfort of your command line.
 
-Get <a href="http://codersclan.net/?repo_id=325&source=link">Capistrano support on CodersClan.</a> <a href="http://codersclan.net/?repo_id=325&source=big"><img src="http://www.codersclan.net/gs_button/?repo_id=325" width="150"></a>
+```
+$ cd my-capistrano-enabled-project
+$ cap production deploy
+```
+
+When you run `cap`, Capistrano dutifully connects to your server(s) via SSH and executes the steps necessary to deploy your project. You can define those steps yourself by writing [Rake](https://github.com/ruby/rake) tasks, or by using pre-built task libraries provided by the Capistrano community.
+
+Tasks are simple to make. Here's an example:
+
+```ruby
+task :restart_sidekiq do
+  on roles(:worker) do
+    execute :service, "sidekiq restart"
+  end
+end
+after "deploy:published", "restart_sidekiq"
+```
+
+*Note: This documentation is for the current version of Capistrano (3.x). If you are looking for Capistrano 2.x documentation, you can find it in [this archive](https://github.com/capistrano/capistrano-2.x-docs).*
+
+---
+
+## Contents
+
+* [Features](#features)
+* [Gotchas](#gotchas)
+* [Quick start](#quick-start)
+* [Finding help and documentation](#finding-help-and-documentation)
+* [How to contribute](#how-to-contribute)
+* [License](#license)
+
+## Features
+
+There are many ways to automate deployments, from simple rsync bash scripts to complex containerized toolchains. Capistrano sits somewhere in the middle: it automates what you already know how to do manually with SSH, but in a repeatable, scalable fashion. There is no magic here!
+
+Here's what makes Capistrano great:
+
+#### Strong conventions
+
+Capistrano defines a standard deployment process that all Capistrano-enabled projects follow by default. You don't have to decide how to structure your scripts, where deployed files should be placed on the server, or how to perform common tasks: Capistrano has done this work for you.
+
+#### Multiple stages
+
+Define your deployment once, and then easily parameterize it for multiple *stages* (environments), e.g. `qa`, `staging`, and `production`. No copy-and-paste necessary: you only need to specify what is different for each stage, like IP addresses.
+
+#### Parallel execution
+
+Deploying to a fleet of app servers? Capistrano can run each deployment task concurrently across those servers and uses connection pooling for speed.
+
+#### Server roles
+
+Your application may need many different types of servers: a database server, an app server, two web servers, and a job queue work server, for example. Capistrano lets you tag each server with one or more roles, so you can control what tasks are executed where.
+
+#### Community driven
 
-## Requirements
+Capistrano is easily extensible using the rubygems package manager. Deploying a Rails app? Wordpress? Laravel? Chances are, someone has already written Capistrano tasks for your framework of choice and has distributed it as a gem. Many Ruby projects also come with Capistrano tasks built-in.
 
-* Ruby >= 1.9.3 (JRuby and C-Ruby/YARV are supported)
+#### It's just SSH
 
-Capistrano support these source code version control systems out of the box:
+Everything in Capistrano comes down to running SSH commands on remote servers. On the one hand, that makes Capistrano simple. On the other hand, if you aren't comfortable SSH-ing into a Linux box and doing stuff on the command-line, then Capistrano is probably not for you.
 
-* Git 1.8 or higher
-* Mercurial
-* SVN
+## Gotchas
 
-Binaries for these VCS might be required on the local and/or the remote systems.
+While Capistrano ships with a strong set of conventions that are common for all types of deployments, it needs help understanding the specifics of your project, and there are some things Capistrano is not suited to do.
 
-## Installation
+#### Project specifics
 
-Add this line to your application's Gemfile:
+Out of the box, Capistrano can deploy your code to server(s), but it does not know how to *execute* your code. Does `foreman` need to be run? Does Apache need to be restarted? You'll need to tell Capistrano how to do this part by writing these deployment steps yourself, or by finding a gem in the Capistrano community that does it for you.
+
+#### Key-based SSH
+
+Capistrano depends on connecting to your server(s) with SSH using key-based (i.e. password-less) authentication. You'll need this working before you can use Capistrano.
+
+#### Provisioning
+
+Likewise, your server(s) will likely need supporting software installed before you can perform a deployment. Capistrano itself has no requirements other than SSH, but your application probably needs database software, a web server like Apache or Nginx, and a language runtime like Java, Ruby, or PHP. These *server provisioning* steps are not done by Capistrano.
+
+#### `sudo`, etc.
+
+Capistrano is designed to deploy using a single, non-privileged SSH user, using a *non-interactive* SSH session. If your deployment requires `sudo`, interactive prompts, authenticating as one user but running commands as another, you can probably accomplish this with Capistrano, but it may be difficult. Your automated deployments will be much smoother if you can avoid such requirements.
+
+#### Shells
+
+Capistrano 3 expects a POSIX shell like Bash or Sh. Shells like tcsh, csh, and such may work, but probably will not.
+
+## Quick start
+
+### Requirements
+
+* Ruby version 2.0 or higher on your local machine (MRI or Rubinius)
+* A project that uses source control (Git, Mercurial, and Subversion support is built-in)
+* The SCM binaries (e.g. `git`, `hg`) needed to check out your project must be installed on the server(s) you are deploying to
+* [Bundler](http://bundler.io), along with a Gemfile for your project, are recommended
+
+### Install the Capistrano gem
+
+Add Capistrano to your project's Gemfile using `require: false`:
 
 ``` ruby
-gem 'capistrano', '~> 3.3.0'
+group :development do
+  gem "capistrano", "~> 3.17", require: false
+end
 ```
 
-And then execute:
+Then run Bundler to ensure Capistrano is downloaded and installed:
 
 ``` sh
 $ bundle install
 ```
 
-Capify:
-*make sure there's no "Capfile" or "capfile" present*
+### "Capify" your project
+
+Make sure your project doesn't already have a "Capfile" or "capfile" present. Then run:
+
 ``` sh
 $ bundle exec cap install
 ```
 
-This creates the following files:
+This creates all the necessary configuration files and directory structure for a Capistrano-enabled project with two stages, `staging` and `production`:
 
 ```
 ├── Capfile
@@ -56,13 +139,15 @@ This creates the following files:
             └── tasks
 ```
 
-To create different stages:
+To customize the stages that are created, use:
 
 ``` sh
 $ bundle exec cap install STAGES=local,sandbox,qa,production
 ```
 
-## Usage
+Note that the files that Capistrano creates are simply templates to get you started. Make sure to edit the `deploy.rb` and stage files so that they contain values appropriate for your project and your target servers.
+
+### Command-line usage
 
 ``` sh
 # list all available tasks
@@ -83,41 +168,39 @@ $ bundle exec cap production deploy --prereqs
 
 # trace through task invocations
 $ bundle exec cap production deploy --trace
+
+# lists all config variable before deployment tasks
+$ bundle exec cap production deploy --print-config-variables
 ```
 
-## Testing
+## Finding help and documentation
 
-Capistrano has two test suites: an RSpec suite and a Cucumber suite. The
-RSpec suite handles quick feedback unit specs. The Cucumber features are
-an integration suite that uses Vagrant to deploy to a real virtual
-server. In order to run the Cucumber suite you will need to install
-[Vagrant](http://www.vagrantup.com/) and Vagrant supported
-virtualization software like
-[VirtualBox](https://www.virtualbox.org/wiki/Downloads).
+Capistrano is a large project encompassing multiple GitHub repositories and a community of plugins, and it can be overwhelming when you are just getting started. Here are resources that can help:
 
-```
-# To run the RSpec suite
-$ rake spec
+* **The [docs](docs) directory contains the official documentation**, and is used to generate the [Capistrano website](http://capistranorb.com)
+* [Stack Overflow](http://stackoverflow.com/questions/tagged/capistrano) has a Capistrano tag with lots of activity
+* [The Capistrano mailing list](https://groups.google.com/forum/#!forum/capistrano) is low-traffic but is monitored by Capistrano contributors
+* [CodersClan](http://codersclan.net/?repo_id=325&source=link) has Capistrano experts available to solve problems for bounties
 
-# To run the Cucumber suite
-$ rake features
+Related GitHub repositories:
 
-# To run the Cucumber suite and leave the VM running (faster for subsequent runs)
-$ rake features KEEP_RUNNING=1
-```
+* [capistrano/sshkit](https://github.com/capistrano/sshkit) provides the SSH behavior that underlies Capistrano (when you use `execute` in a Capistrano task, you are using SSHKit)
+* [capistrano/rails](https://github.com/capistrano/rails) is a very popular gem that adds Ruby on Rails deployment tasks
+* [mattbrictson/airbrussh](https://github.com/mattbrictson/airbrussh) provides Capistrano's default log formatting
+
+GitHub issues are for bug reports and feature requests. Please refer to the [CONTRIBUTING](CONTRIBUTING.md) document for guidelines on submitting GitHub issues.
+
+If you think you may have discovered a security vulnerability in Capistrano, do not open a GitHub issue. Instead, please send a report to <security@capistranorb.com>.
 
-## SSHKit
+## How to contribute
 
-[SSHKit](https://github.com/leehambley/sshkit) is the driver for SSH
-connections behind the scenes in Capistrano. Depending on how deep you dig, you
-might run into interfaces that come directly from SSHKit (the configuration is
-a good example).
+Contributions to Capistrano, in the form of code, documentation or idea, are gladly accepted. Read the [DEVELOPMENT](DEVELOPMENT.md) document to learn how to hack on Capistrano's code, run the tests, and contribute your first pull request.
 
 ## License
 
 MIT License (MIT)
 
-Copyright (c) 2012-2015 Tom Clements, Lee Hambley
+Copyright (c) 2012-2020 Tom Clements, Lee Hambley
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/RELEASING.md

@@ -0,0 +1,17 @@
+# Releasing
+
+## Prerequisites
+
+* You must have commit rights to the Capistrano repository.
+* You must have push rights for the capistrano gem on rubygems.org.
+
+## How to release
+
+1. Run `bundle install` to make sure that you have all the gems necessary for testing and releasing.
+2.  **Ensure all tests are passing by running `rake spec` and `rake features`.**
+3. Determine which would be the correct next version number according to [semver](http://semver.org/).
+4. Update the version in `./lib/capistrano/version.rb`.
+5. Update the version in the `./README.md` Gemfile example (`gem "capistrano", "~> X.Y"`).
+6. Commit the `version.rb` and `README.md` changes in a single commit, the message should be "Release vX.Y.Z"
+7. Run `rake release`; this will tag, push to GitHub, and publish to rubygems.org.
+8. Update the draft release on the [GitHub releases page](https://github.com/capistrano/capistrano/releases) to point to the new tag and publish the release

data/Rakefile

@@ -2,8 +2,19 @@ require "bundler/gem_tasks"
 require "cucumber/rake/task"
 require "rspec/core/rake_task"
 
-task :default => :spec
-RSpec::Core::RakeTask.new
+begin
+  require "rubocop/rake_task"
+  desc "Run RuboCop checks"
+  RuboCop::RakeTask.new
+  task default: %i(spec rubocop)
+rescue LoadError
+  task default: :spec
+end
 
+RSpec::Core::RakeTask.new
 Cucumber::Rake::Task.new(:features)
 
+Rake::Task["release"].enhance do
+  puts "Don't forget to publish the release on GitHub!"
+  system "open https://github.com/capistrano/capistrano/releases"
+end