[Bps-public-commit] rt-extension-tags branch, master, updated. 0.02-2-g4d816f2

[Jim Brandt]

The branch, master has been updated
       via  4d816f29df61b7ca9481467fd757f88ae4f40dcd (commit)
      from  12a824c318584b64fd1f3788a6f64a945175d8f6 (commit)

Summary of changes:
 README                   | 39 ++++++++++++++++++++-------------------
 lib/RT/Extension/Tags.pm | 21 +++++++++++++++++++++
 2 files changed, 41 insertions(+), 19 deletions(-)

- Log -----------------------------------------------------------------
commit 4d816f29df61b7ca9481467fd757f88ae4f40dcd
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Fri Aug 5 15:26:00 2016 -0400

    Add docs for upgrading from 0.01 or 0.02

diff --git a/README b/README
index 8725bb2..b692544 100644
--- a/README
+++ b/README
@@ -3,28 +3,15 @@ NAME
 
 DESCRIPTION
     This extension allows you to create tags using custom fields on tickets.
-    RT has a custom field type that allows you to select multiple values
-    with autocomplete from a list of values. This extension allows users to
-    add new values (tags) that will then be added to the list of available
+    It adds a new custom field type, "Tags", which allows users to add new
+    values (tags) that will then be added to the list of available
     autocomplete values for that custom field.
 
     The created tags become links to a search of all active tickets with
     that tag.
 
   Tag Custom Field
-    The initdb step installs a Tag custom field by default along with the
-    required condition, action, and scrip. The custom field is global as
-    installed, but you can limit it to specific queues by editing the custom
-    field configuration.
-
-    If you want to use this functionality with a different custom field,
-    create the custom field, then create a new scrip. You can use the
-    provided "On Custom Field Change" condition as is. Then create a new
-    action in the RT database using the same values as the provided "Add New
-    CF Value" but change the Argument to the name of your new custom field.
-    You can add this with a short initial data file, directly in the
-    database, or using the helpful extension
-    RT::Extension::AdminConditionsAndActions.
+    The initdb step installs an example global Tag custom field.
 
 RT VERSION
     Works with RT 4.0, 4.2, 4.4
@@ -36,9 +23,7 @@ INSTALLATION
         May need root permissions
 
     make initdb
-        Only run this the first time you install the module. Creates a
-        global Tags custom field and adds the necessary scrip, action, and
-        condition.
+        This optional step installs an example global Tag custom field.
 
     Edit your /opt/rt4/etc/RT_SiteConfig.pm
         If you are using RT 4.2 or greater, add this line:
@@ -56,6 +41,22 @@ INSTALLATION
 
     Restart your webserver
 
+  UPGRADING
+    If you are upgrading from version 0.01 or 0.02, note that the custom
+    field type was changed from a default RT "multiple values with
+    autocompletion" to a dedicated tag custom field type. To upgrade:
+
+    *   Change your Tag custom field to use the new tag custom field type
+
+        You can either edit your existing custom field and change the Type
+        to "Enter multiple tags" or run the initdb step and copy your values
+        to the new Tag custom field automatically created.
+
+    *   Disable the scrip "On Custom Field Change Add New Tag Values"
+
+        This scrip is no longer needed with the new tag custom field type,
+        so you can disable or delete it.
+
 AUTHOR
     Best Practical Solutions, LLC <modules at bestpractical.com>
 
diff --git a/lib/RT/Extension/Tags.pm b/lib/RT/Extension/Tags.pm
index d5dba3b..60fa129 100644
--- a/lib/RT/Extension/Tags.pm
+++ b/lib/RT/Extension/Tags.pm
@@ -104,6 +104,27 @@ or add C<RT::Extension::Tags> to your existing C<@Plugins> line.
 
 =back
 
+=head2 UPGRADING
+
+If you are upgrading from version 0.01 or 0.02, note that the custom field
+type was changed from a default RT "multiple values with autocompletion" to
+a dedicated tag custom field type. To upgrade:
+
+=over
+
+=item * Change your Tag custom field to use the new tag custom field type
+
+You can either edit your existing custom field and change the Type to "Enter
+multiple tags" or run the initdb step and copy your values to the new Tag
+custom field automatically created.
+
+=item * Disable the scrip "On Custom Field Change Add New Tag Values"
+
+This scrip is no longer needed with the new tag custom field type,
+so you can disable or delete it.
+
+=back
+
 =head1 AUTHOR
 
 Best Practical Solutions, LLC E<lt>modules at bestpractical.comE<gt>

-----------------------------------------------------------------------