Adding postinstall message

Adding a simple postinstall message to tell users not to use
fog gem if they require only specific dependencies.

Fixing #3876
This commit is contained in:
Artem Yakimenko 2016-04-14 22:08:19 +02:00
parent db0751555a
commit 9755b654d6
2 changed files with 30 additions and 0 deletions

View File

@ -11,6 +11,19 @@ fog is the Ruby cloud services library, top to bottom:
[![Code Climate](https://codeclimate.com/github/fog/fog/badges/gpa.svg)](https://codeclimate.com/github/fog/fog)
[![Gem Version](https://badge.fury.io/rb/fog.svg)](http://badge.fury.io/rb/fog)
## Dependency Notice
Currently all fog providers are getting separated into metagems to lower the
load time and dependency count.
If there's a metagem available for your cloud provider, e.g. `fog-aws`,
you should be using it instead of requiring the full fog collection to avoid
unnecessary dependencies.
'fog' should be required explicitly only if:
- The provider you use doesn't yet have a metagem available.
- You require Ruby 1.9.3 support.
## Getting Started
The easiest way to learn fog is to install the gem and use the interactive console.

View File

@ -98,4 +98,21 @@ Gem::Specification.new do |s|
s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {spec,tests}/*`.split("\n")
postinstall_message = <<-POSTINST
------------------------------
Thank you for installing fog!
IMPORTANT NOTICE:
If there's a metagem available for your cloud provider, e.g. `fog-aws`,
you should be using it instead of requiring the full fog collection to avoid
unnecessary dependencies.
'fog' should be required explicitly only if:
- The provider you use doesn't yet have a metagem available.
- You require Ruby 1.9.3 support.
------------------------------
POSTINST
s.post_install_message = postinstall_message
end