PERFORCE DEFECT TRACKING INTEGRATION README FOR RELEASE 1.1.3 Richard Brooksby, Ravenbrook Limited $Date: 2001/07/19 $ CONTENTS 1. Introduction 2. Installation 2.1. Upgrading from an old release of the P4DTI 2.2. Installing the TeamTrack integration 2.3. Installing the Bugzilla integration on Linux 2.4. Installing the Bugzilla integration on Solaris 2.5. Installing the integration kit A. References B. Document history 1. INTRODUCTION This is release 1.1.3 of the Perforce Defect Tracking Integration (P4DTI). The P4DTI connects your defect tracking system to Perforce, so that you don't have to switch between them and enter duplicate information about your work. It also links changes made in Perforce with defect tracker issues, making it easy to find out why a change was made, find the work that was done to resolve an issue, or generate reports relating issues to files or codelines. For supported configurations, contact information, and what's new in this release, see the release notes (release-notes.txt). If you are planning to modify, adapt, or extend the P4DTI, please download and unpack the P4DTI Integration Kit. See section 2.5. The readership of this document is anyone who wants to download and use the Perforce Defect Tracking Integration. This document is not confidential. 2. INSTALLATION 2.1. Upgrading from an old release of the P4DTI If you're running an old release of the P4DTI, then you must follow these steps when upgrading to this release: 1. Stop the replicator. 2. Make a copy of your configuration file in a safe place (this configuration file is config_teamtrack.py if you were using release 0.4.*, config_bugzilla.py if you were using release 0.5.*, or config.py otherwise). 3. If you're running the Bugzilla integration, remove the old Bugzilla patch. Go to the Bugzilla installation directory and run the command: patch -R < /opt/p4dti/bugzilla-VERSION-patch where VERSION is the version of Bugzilla (2.10 or 2.12). (If you didn't install the Bugzilla integration as an RPM, then the patch file will be wherever you installed it, not necessarily in /opt/p4dti.) 4. If your old release was installed as an RPM, run the following command as root to uninstall it: rpm -e p4dti 5. Install the P4DTI as normal (see sections 2.2 to 2.4 below). 6. Use the values from your old configuration file when configuring the new release. 2.2. Installing the TeamTrack integration On the TeamTrack server machine, run the "p4dti-teamtrack-1.1.3.exe" installer program that came with this document. This will unpack the integration. We recommend installing the integration in "C:\Program Files\P4DTI-1.1.3\" but you can ask the installer to put it somewhere else. Then consult the Administrator's Guide (installed by default in "C:\Program Files\P4DTI-1.1.3\ag\index.html") for further instructions. 2.3. Installing the Bugzilla integration on Linux The integration is distributed as an RPM called "p4dti-1.1.3-1.i386.rpm". Transfer this to the Bugzilla server machine, then run the following command as root: rpm -i p4dti-1.1.3-1.i386.rpm This will install the P4DTI files into /opt/p4dti and a startup script in the /etc/rc.d/init.d directory. Then consult the Administrator's Guide (installed as "/usr/doc/p4dti-1.1.3/ag/index.html") for further instructions. If you prefer not to use RPMs, you can follow the procedure in section 2.4. 2.4. Installing the Bugzilla integration on Solaris The integration is distributed as a gzipped tar file called "p4dti-bugzilla-1.1.3.tar.gz". Unpack this tarball on the Bugzilla server machine, using the command gunzip -c p4dti-bugzilla-1.1.3.tar.gz | tar xvf - Then consult the Administrator's Guide (installed as "p4dti-bugzilla-1.1.3/ag/index.html") for further instructions. 2.5. Installing the integration kit The P4DTI integration kit is a complete set of P4DTI sources and documentation to enable third parties to develop new integrations. You should only install it if you are planning to modify, adapt, or extend the P4DTI. For Windows, the integration kit is distributed as the ZIP archive "p4dti-kit-1.1.3.zip". Unpack it using WinZip. For Unix, the integration kit is distributed as the tarball "p4dti-kit-1.1.3.tar.gz". Unpack it using the command "gunzip -c p4dti-kit-1.1.3.tar.gz | tar xvf -". Then consult the Integration Kit readme file (p4dti-kit-1.1.3/kit-readme.txt) for further instructions. A. REFERENCES None. B. DOCUMENT HISTORY 2000-10-19 RB Created using FreeBSD release documents as a model. 2000-11-08 RB Updated to explain purpose of release 0.3.3. Added references to reports. Improved instructions for obtaining special client and builds. Added a summary of changes. Added readership and confidentiality. 2000-11-20 RB Made it clearer where the Administrator's Guide and the installer file come from. 2000-11-30 RB Partially updated for version 0.4. 2000-12-01 RB Updated references to the "SAG" to "AG" since it's now called the Administrator's Guide. 2000-12-05 RB Added list of known issues generated from Ravenbrook jobs. Updated support information. 2000-12-05 GDR Section 4 says "first public release" only. 2000-12-07 GDR Updated for release 0.4.1. 2000-12-08 RB Updated for release 0.4.2. 2000-12-13 RB Updated for version 0.5. Updated for release 0.5.0. 2000-12-15 NB Added pointer to AG from Linux instructions. 2000-12-15 NB Clarified pointer to defect reports. 2000-12-15 RB Changed Bugzilla install directory to p4dti-bugzilla-RELEASE for consistency with many other Unix packages. 2000-12-15 NB Conditionalize TeamTrack text. 2000-12-15 NB Updated for release 0.5.1. 2000-12-18 NB Merged back into masters. 2001-02-15 RB Updated for version 1.0, pointing people at Perforce and TeamShare rather than Ravenbrook for information and support. 2001-02-19 GDR Added fixed and known issues for release 1.0.0. 2001-02-20 GDR Added Date keyword to fix job000218; swapped sections 4 and 5 to fix job000219. 2001-02-22 GDR Moved material not related to installation to separate release notes. Added instructions on upgrading from an old release. 2001-02-27 NB Fixed typo in 2.3, added AG reference to 2.3, added RPM uninstall instruction to 2.1. 2001-03-02 RB Transferred copyright to Perforce under their license. 2001-03-02 NB Updated to 1.0.2. 2001-03-05 NB Fixed references to 1.0.1. 2001-03-06 GDR Updated to 1.0.3. 2001-03-19 RB Updated to 1.0.4. 2001-03-21 RB Updated to 1.0.5. 2001-03-26 RB Added directions to the Integration Kit. Updated for version 1.1. 2001-04-10 NB Updated to 1.1.0. Added more integration kit instructions. 2001-04-11 RB Updated for release 1.1.1. Added back the descriptive paragraph. 2001-06-08 GDR Added instructions for unpacking the Integration Kit on Windows. 2001-07-16 GDR Updated for release 1.1.2. 2001-07-19 GDR Remove Bugzilla patch when upgrading. Updated for release 1.1.3. C. COPYRIGHT AND LICENCE This document is copyright (C) 2001 Perforce Software, Inc. All rights reserved. Redistribution and use of this document in any form, with or without modification, is permitted provided that redistributions of this document retain the above copyright notice, this condition and the following disclaimer. THIS DOCUMENT IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. $Id: //info.ravenbrook.com/project/p4dti/release/1.1.3/readme.txt#1 $