Added deprecation notice for MySQL-Sandbox.

datacharmer · Apr 16, 2018 · 828e89a · 828e89a
1 parent 758607b
commit 828e89a
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 11 deletions.
diff --git a/Changelog b/Changelog
@@ -1,3 +1,5 @@
+3.2.17	16-Apr-2018
+	- Added deprecation notice for MySQL-Sandbox.
 3.2.16	04-Jan-2018
 	- Added backward compatibility options for authentication plugin in MySQL 8.0.4.
 	The default authentication was changed from mysql_native_password to 

diff --git a/README.md b/README.md
@@ -1,8 +1,3 @@
-# Project being replaced
-
-**WARNING**: This project is replaced by [dbdeployer](https://github.com/datacharmer/dbdeployer), which is now GA. It can already support almost all MySQL-Sandbox features, plus a few new ones. 
-In the near future, this project will be supported only with bug fixes, but the development of new feature and the support for newer versions of MySQL will only continue in **dbdeployer**. 
-
 # NAME
 
 MySQL::Sandbox - Quickly installs one or more MySQL servers (or forks) in the same host, either standalone or in groups
@@ -18,6 +13,10 @@ MySQL::Sandbox - Quickly installs one or more MySQL servers (or forks) in the sa
 
     make_sandbox VERSION
 
+# WARNING
+
+This project is replaced by [dbdeployer](https://github.com/datacharmer/dbdeployer), which is now GA. It can already support almost all MySQL-Sandbox features, plus a few new ones. In the near future, this project will be supported only with bug fixes, but the development of new feature and the support for newer versions of MySQL will only continue in dbdeployer.
+
 # PURPOSE
 
 This package is a sandbox for testing features under any version of

diff --git a/bin/make_sandbox b/bin/make_sandbox
@@ -19,7 +19,7 @@ use strict;
 use warnings;
 # use Data::Dumper;
 use English qw( -no_match_vars ); 
-use MySQL::Sandbox qw( runs_as_root sbinstr exists_in_path);
+use MySQL::Sandbox qw( runs_as_root sbinstr exists_in_path deprecation_notice);
 use Getopt::Long ;
 
 
@@ -281,6 +281,7 @@ sub get_help {
               $msg,
               '*' x $len, "\n";
     }
+    deprecation_notice();
     print <<SYNTAX;
 usage: ./make_sandbox full_version [options] {VERSION|tarball_full_name} -- [more options]
 or   : ./make_sandbox GET:short_version -- [options]

diff --git a/bin/sbtool b/bin/sbtool
@@ -33,6 +33,7 @@ use MySQL::Sandbox qw(
                 get_ranges
                 get_option_file_contents
                 sbinstr
+                deprecation_notice
                 get_sb_info);
 
 use MySQL::Sandbox::Scripts;
@@ -161,6 +162,7 @@ else {
 sub get_help {
     my ($msg) = @_;
     print MySQL::Sandbox::credits();
+    deprecation_notice();
     if ($msg) {
         print '*' x 50;
         print "\n", $msg, "\n";

diff --git a/lib/MySQL/Sandbox.pm b/lib/MySQL/Sandbox.pm
@@ -29,9 +29,10 @@ our @EXPORT_OK= qw( is_port_open
                     fix_server_uuid
                     greater_version
                     split_version
+                    deprecation_notice
                     ) ;
 
-our $VERSION=q{3.2.16};
+our $VERSION=q{3.2.17};
 our $DEBUG;
 
 BEGIN {
@@ -158,6 +159,17 @@ sub find_safe_port_and_directory {
     return ($chosen_port, $chosen_dir);
 }
 
+sub deprecation_notice {
+    print "#############################################################################\n";
+    print "#                             IMPORTANT NOTICE                              #\n";
+    print "# ------------------------------------------------------------------------- #\n";
+    print "# MySQL-Sandbox is NOT MAINTAINED anymore.                                  #\n";
+    print "# It may fail on recent MySQL versions.                                     #\n";
+    print "# You should use **dbdeployer** (https://github.com/datacharmer/dbdeployer) #\n";
+    print "#############################################################################\n";
+    print "\n";
+}
+
 sub get_help {
     my ($self, $msg) = @_;
     if ($msg) {
@@ -236,7 +248,7 @@ sub get_help {
             . "          version number.\n\n"
             . $HELP_MSG;
    } 
-    
+   deprecation_notice();
    print $self->credits(),
           "syntax: $PROGRAM_NAME [options] $target \n", 
           $HELP_MSG,
@@ -247,7 +259,8 @@ sub get_help {
           #"\nExample:\n",
           #"     $PROGRAM_NAME --my_file=large --sandbox_directory=my_sandbox\n\n";
 
-    exit(1);
+   deprecation_notice();
+   exit(1);
 }
 
 sub credits {
@@ -823,6 +836,11 @@ MySQL::Sandbox - Quickly installs one or more MySQL servers (or forks) in the sa
 
  make_sandbox VERSION
 
+=head1 WARNING
+
+This project is replaced by L<dbdeployer|https://github.com/datacharmer/dbdeployer>, which is now GA. It can already support almost all MySQL-Sandbox features, plus a few new ones. In the near future, this project will be supported only with bug fixes, but the development of new feature and the support for newer versions of MySQL will only continue in dbdeployer.
+
+
 =head1 PURPOSE
 
 This package is a sandbox for testing features under any version of

diff --git a/lib/MySQL/Sandbox/Recipes.pm b/lib/MySQL/Sandbox/Recipes.pm
@@ -3,7 +3,7 @@ package MySQL::Sandbox::Recipes;
 use strict;
 use warnings;
 
-our $VERSION=q{3.2.16};
+our $VERSION=q{3.2.17};
 
 1;
 __END__

diff --git a/lib/MySQL/Sandbox/Scripts.pm b/lib/MySQL/Sandbox/Scripts.pm
@@ -17,7 +17,7 @@ our @EXPORT_OK = qw(
     );
 our @EXPORT = @EXPORT_OK;
 
-our $VERSION=q{3.2.16};
+our $VERSION=q{3.2.17};
 
 our @MANIFEST = (
 'clear.sh',