WebSVN – DevTools – Diff – /core_devl/trunk/TOOLS/jats_gen_releasenote.pl

+#
 # Description   : Generate the package Release Note
 #                 Requires
 #                   1) Release Note data generated by jats_get_releasenote_data.pl
 #                   2) Target package in dpkg_archive
-#                   3) One or more built.files.xxx.xml
+#                   3) One or more built.files.xxx.xml (optional, but desirable)
+#
 #                 Will:
-#                   Merge built.files..xml files into the release note data
+#                   Merge built.files.xxx.xml files into the release note data
 #                   Insert build meta data
 #                   Save the Release Note MetaData within the package
 #                   Generate the HTML release note - save within the package
+#                   Insert Release_Contents into RM Database
+#
 # Usage:        See POD
+#
 #......................................................................#
 my $opt_pname;
 my $opt_pversion;
 my $opt_release_note;
 my $opt_pvid;
 my $opt_outname;
+my $opt_outputXml;
 my $opt_updateRmFiles;
 my $opt_workingDir;
 #   Global vars
 our $GBE_HOSTNAME;
         $opt_workingDir = FullPath($opt_workingDir);
         Error("Working directory is not a directory") unless -d $opt_workingDir;
         Error("Working directory is writable") unless -w $opt_workingDir;
+    }
+    #
     #   Determine the target archive
     #   The default archive is GBE_DPKG, but this may be changed
+    #
     $opt_archive = 'main' unless ( $opt_archive );
     #   Needs to mimic $DPKG_ROOT
     $OUT_ROOT = defined($opt_workingDir) ? $opt_workingDir : $DPKG_ROOT;
     Verbose2 ("Output Path: $OUT_ROOT" );
+    #
+    #   Calculate output filenames
+    #   Html Release Note:
+    #       RELEASE_NOTES_PVID_PKGNAME_CLEANV.html
+    #
+    $DPKG_DOC = catdir($OUT_ROOT, 'doc');
+    $opt_outputXml = catdir($DPKG_DOC, 'release_note.xml');
+    my $cleanv = $opt_pversion;
+    $cleanv =~ s~\.~_~g;
+    $opt_outname = join('_',
+                        'RELEASE_NOTES',
+                        $opt_pvid,
+                        $opt_pname,
+                        $cleanv,
+                        ) . '.html';
+    Verbose("Note Name: $opt_outname");
+    #
     #   Locate the release note data file
     #   This was created as a prerequisite to the build
     #   Note: windows requires '/' in the file list
+    #
     my @filesList;
         $item =~ s~\\~/~g;
         push @filesList, $item;
+    }
     unless (scalar @filesList > 0)
+    {
+        Warning("No file list found within the package");
+        #
         #   No filelist found in the package
         #   This may occur for packages that did not go though the build system
         #   Create a package-list
+        #
         my $item = generateFileList();
         $item =~ s~\\~/~g;
         push @filesList, $item;
+    }
-    Error("No file list found within the package") unless (scalar @filesList > 0);
+    #
-    #   Generate the name of the release note
-    #       RELEASE_NOTES_PVID_PKGNAME_CLEANV.html
-    #
-    my $cleanv = $opt_pversion;
-    $cleanv =~ s~\.~_~g;
-    $opt_outname = join('_',
-                        'RELEASE_NOTES',
-                        $opt_pvid,
-                        $opt_pname,
-                        $cleanv,
-                        ) . '.html';
-    Verbose("Note Name: $opt_outname");
-    #
     #   Create output directory within the package
+    #
-    $DPKG_DOC = catdir($OUT_ROOT, 'doc');
     mkpath($DPKG_DOC, 0, 0775);
+    #
     #   Merge the Release Note and the various file lists into a single
     #   XML file. Keep the file local
             );
+    #
     #   Transfer the XML database directly into the package
+    #
-    unless( File::Copy::copy('built.files.releasenote.xml', catdir($DPKG_DOC, 'release_note.xml')) )
+    unless( File::Copy::copy('built.files.releasenote.xml', $opt_outputXml) )
+    {
-        Error("Cannot transfer XML release note", $!);
+        Error("Cannot transfer XML release note", $!, $opt_outputXml);
+    }
+    #
+    #   Delete the built.files.xxx.xml that may be present in the root of the package
+    #   These are no longer needed - they have been incorporated into the release_note.xml file
+    #
+    foreach my $item ( glob(catdir($DPKG_ROOT, 'built.files.*.xml'))) {
+        unlink $item;
+    }
+    #
     #   Update the Release Manager entry - File Data
+    #
     $updateRmFilesData = "";
     foreach my $entry (@{$xml->{files}{file}})
+    {
+        #
+        #   Ignore 'merge' entries
+        #
+        next if ((exists $entry->{type}) && ($entry->{type} eq 'merge'));
+        #
         #   Clean up the data
+        #
         my $fname = $entry->{name} || '';
         my $fpath  = $entry->{path} || '';
         my $fsize  = $entry->{size} || 0;
 =item B<-UpdateRmFiles>
 This option will case the utility to ppdate the Files list in Release Manager.
-The existinf file list will be replaced by the one within the package.
+The existing file list will be replaced by the one within the package.
 Note: Write Access to Release Manager is required.
 =back
 an HTML based release note.
 =head1 EXAMPLE
-=head2 jats get_releasenote_data -pvid=983058 -outfile=tmpdata.xml
+=head2 jats jats_gen_releasenote -releasenote=/tmp/myreleasenote.xml
-This will locate a package-version with an id of 983058, extrat required information and create
+This will process release note data in the specified XML file.
-an XML file called tmpdata.xml.
 =cut

Subversion Repositories DevTools

(root)/core_devl/trunk/TOOLS/jats_gen_releasenote.pl @ 4619 – Rev 4618 → 4619