diff --git a/CHANGELOG.md b/CHANGELOG.md index 004b602a..09f16cd4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,13 +6,13 @@ Reverse Chronological Order: https://github.com/capistrano/capistrano/compare/v3.6.1...HEAD +* Your contribution here! * The `set :scm, ...` mechanism is now deprecated in favor of a new SCM plugin -system. See the [UPGRADING](UPGRADING.md) document for details. +system. See the [UPGRADING-3.7](UPGRADING-3.7.md) document for details. * The `:git_strategy`, `:hg_strategy`, and `:svn_strategy` settings have been removed with no replacement. If you have been using these to customize Capistrano's SCM behavior, you will need to rewrite your customization using the [new plugin system](https://github.com/capistrano/documentation/pull/188). -* Your contribution here! * The `tar` used by the Git SCM now honors the SSHKit command map, allowing an alternative tar binary to be used (e.g. gtar) #1787 (@caius) * Fix test suite to work with Mocha 1.2.0 (@caius) * `remote_file` feature has been removed and is no longer available to use @SaiVardhan diff --git a/UPGRADING.md b/UPGRADING.md deleted file mode 100644 index 24d79485..00000000 --- a/UPGRADING.md +++ /dev/null @@ -1,50 +0,0 @@ -# Upgrading Capistrano - -From time to time Capistrano will introduce changes and new features that may -break existing projects. This document describes how to upgrade your project in -case you are affected by these changes. - -## 3.5.x -> master - -### SCM Changes - -Capistrano is moving to a new system for choosing and customizing the SCM used -in your deployments -(see [#1572](https://github.com/capistrano/capistrano/pull/1572)). -In a nutshell, this means: - -* The `set :scm, ...` mechanism is deprecated in favor of a plugin system - described below. -* In a future release, no SCM will be loaded by default. To prepare your - project, you should explicitly load the Git SCM. - -To upgrade your project, edit your Capfile to specify the SCM you are using, -like this: - -```ruby -# Add *one* of the following to your Capfile - -# If your project uses Git: -require "capistrano/scm/git" -install_plugin Capistrano::SCM::Git - -# If your project uses Subversion: -require "capistrano/scm/svn" -install_plugin Capistrano::SCM::Svn - -# If your project uses Mercurial: -require "capistrano/scm/hg" -install_plugin Capistrano::SCM::Hg -``` - -Then **remove** any `set :scm, ...` line from your `deploy.rb`: - -```ruby -# REMOVE THIS -set :scm, :git -``` - -**If you are using a third-party SCM,** you can continue using it without -changes, but you will see deprecation warnings. Contact the maintainer of the -third-party SCM gem and ask them about modifying the gem to work with the new -Capistrano SCM plugin system.