[Bps-public-commit] rt-extension-changemanagement branch combine-install-upgrade-docs created. 0.02-1-gcd680ab

BPS Git Server git at git.bestpractical.com
Fri Dec 30 19:50:38 UTC 2022


This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "rt-extension-changemanagement".

The branch, combine-install-upgrade-docs has been created
        at  cd680ab0daf1912a5c2b346ab6b588527a68eb36 (commit)

- Log -----------------------------------------------------------------
commit cd680ab0daf1912a5c2b346ab6b588527a68eb36
Author: Jason Crome <jcrome at bestpractical.com>
Date:   Tue May 17 09:40:28 2022 -0400

    Merge installation and upgrade documentation

diff --git a/README b/README
index 59e524d..23a199f 100644
--- a/README
+++ b/README
@@ -19,14 +19,24 @@ INSTALLATION
         Only run this the first time you install this module. If you run
         this twice, you may end up with duplicate data in your database.
 
+        If you are upgrading this module, check the upgrading instructions
+        below in case changes need to be made to your database.
+
     Clear your mason cache
             rm -rf /opt/rt5/var/mason_data/obj
 
     Restart your webserver
 
 UPGRADING
-    To upgrade from an earlier version, see the instructions in the
-    UPGRADING document.
+    If you are upgrading from version 0.01, you need to run an upgrade step
+    on your RT database. Run the following from inside the source of this
+    extension:
+
+        /opt/rt5/sbin/rt-setup-database --action insert --datafile etc/upgrade/0.02/content \
+            --package RT::Extension::ChangeManagement --ext-version 0.02
+
+    It will prompt you for your DBA password, and should complete without
+    error.
 
 DESCRIPTION
     This extension provides the configuration to implement a change
diff --git a/UPGRADING.pod b/UPGRADING.pod
deleted file mode 100644
index 33fdb0a..0000000
--- a/UPGRADING.pod
+++ /dev/null
@@ -1,27 +0,0 @@
-=head1 UPGRADING FROM 0.01
-
-The upgrade process is very similar to installation:
-
-=over
-
-=item C<perl Makefile.PL>
-
-=item C<make>
-
-=item C<make install>
-
-=back
-
-Once C<make install> finishes, the database upgrade can be performed:
-
-    /opt/rt5/sbin/rt-setup-database --action insert --datafile etc/upgrade/0.02/content \
-        --package RT::Extension::ChangeManagement --ext-version 0.02
-
-Finally, clear your mason cache:
-
-    rm -rf /opt/rt5/var/mason_data/obj
-
-and restart your webserver.
-
-=cut
-
diff --git a/lib/RT/Extension/ChangeManagement.pm b/lib/RT/Extension/ChangeManagement.pm
index 3b3e0f3..73c519f 100644
--- a/lib/RT/Extension/ChangeManagement.pm
+++ b/lib/RT/Extension/ChangeManagement.pm
@@ -35,6 +35,9 @@ Add this line:
 Only run this the first time you install this module. If you run this twice,
 you may end up with duplicate data in your database.
 
+If you are upgrading this module, check the upgrading instructions below
+in case changes need to be made to your database.
+
 =item Clear your mason cache
 
     rm -rf /opt/rt5/var/mason_data/obj
@@ -45,8 +48,15 @@ you may end up with duplicate data in your database.
 
 =head1 UPGRADING
 
-To upgrade from an earlier version, see the instructions in the L<UPGRADING|UPGRADING.pod>
-document.
+If you are upgrading from version 0.01, you need to run an upgrade step
+on your RT database. Run the following from inside the source of this
+extension:
+
+    /opt/rt5/sbin/rt-setup-database --action insert --datafile etc/upgrade/0.02/content \
+        --package RT::Extension::ChangeManagement --ext-version 0.02
+
+It will prompt you for your DBA password, and should complete without
+error.
 
 =head1 DESCRIPTION
 
-----------------------------------------------------------------------


hooks/post-receive
-- 
rt-extension-changemanagement


More information about the Bps-public-commit mailing list