Home

cvs-release-notes

August 19, 2008 - 3:33pm — Anonymous
  1. #!/usr/bin/php
  2. <?php
  3.  
  4. // $Id: cvs-release-notes.php,v 1.6 2007/03/06 09:37:48 dww Exp $
  5.  
  6. /**
  7.  * @file
  8.  * Parses all CVS log messages between 2 release tags and automatically
  9.  * generates initial HTML for the release notes. This script must be
  10.  * run inside the root directory of a local CVS workspace of the project
  11.  * you want to generate release notes for.  Assumes "cvs" is in your
  12.  * PATH, and that the workspace has already been checked out with the
  13.  * appropriate CVSROOT.
  14.  *
  15.  * Usage:
  16.  * cvs-release-notes.php [previous-release-tag] [current-release-tag]
  17.  *
  18.  * TODO:
  19.  * - Option to include patch committer if "by" isn't included in message
  20.  * - Pretty formatting of previous release version (instead of the tag)
  21.  * - Lookup issues on d.o to group changes by issue type (bug, feature)
  22.  * - Should strip out leading dashes: "- something"
  23.  * - Should remove the word "Patch " before patch #s so they are
  24.  *   formatted consistently.
  25.  *
  26.  * @author Derek Wright (http://drupal.org/user/46549)
  27.  *
  28.  */
  29.  
  30. if (count($argv) < 3) {
  31.   usage("You must specify the release tags to compare");
  32. }
  33. $prev = $argv[1];
  34. $cur = $argv[2];
  35.  
  36. if (!is_dir('CVS')) {
  37.   usage("You must run this script in a local CVS workspace for your project");
  38. }
  39.  
  40. $changes = get_changes($prev, $cur);
  41. print "<p>Changes since $prev:</p>\n";
  42. print_changes($changes);
  43.  
  44.  
  45. function usage($msg = NULL) {
  46.   global $argv;
  47.   if (!empty($msg)) {
  48.     print "ERROR: $msg\n";
  49.   }
  50.   print <<<EOF
  51. Usage: $argv[0] [previous_release_tag] [current_release_tag]
  52. For example:
  53. $argv[0] DRUPAL-4-7--1-0 DRUPAL-4-7--1-1
  55. EOF;
  56.   exit(empty($msg) ? 0 : 1);
  57. }
  58.  
  59. // Based loosely on cvs.module cvs_process_log()
  60. function get_changes($prev, $cur) {
  61.   $changes = array();
  62.   $rval = '';
  63.   $logs = array();
  64.   exec("cvs -qf log -NS -r$prev::$cur 2>&1", $logs, $rval);
  65.   if ($rval) {
  66.     print "ERROR: 'cvs log' returned failure: $rval";
  67.     print implode("\n", $logs);
  68.     exit(1);
  69.   }
  70.   $msg_sep = '----------------------------';
  71.   $file_sep = '=============================================================================';
  72.   $in_log = false;
  73.   while (($line = next($logs)) !== false) {
  74.     if (preg_match('/^cvs log:.*$/', $line)) {
  75.       next;
  76.     }
  77.     if (trim($line) == $msg_sep || $in_log) {
  78.       if (!$in_log) {
  79.         $in_log = true;
  80.       }
  81.       $entry = new stdClass();
  82.       $parts = explode(' ', next($logs));
  83.       $entry->revision = trim($parts[1]);
  84.       $parts = explode(';', next($logs));
  85.       $entry->date = strtotime(cvs_explode($parts[0]));
  86.       $entry->user = cvs_explode($parts[1]);
  87.       $entry->state = cvs_explode($parts[2]);
  88.       $entry->commitid = cvs_explode($parts[4]);
  89.       $parts = explode(' ', cvs_explode($parts[3]));
  90.       $entry->lines_added = abs($parts[0]);
  91.       $entry->lines_removed = abs($parts[1]);
  92.       $temp = next($logs);
  93.       $comment = substr($temp, 0, 9) != 'branches:' ? $temp : '';
  94.       $cur_log = true;
  95.       while ($cur_log && ($line = next($logs))) {
  96.         if (trim($line) == $msg_sep) {
  97.           prev($logs);  // Need to rewind so our outer loop isn't confused.
  98.           $cur_log = false;
  99.         }
  100.         elseif (trim($line) == $file_sep) {
  101.           $cur_log = false;
  102.           $in_log = false;
  103.         }
  104.         else {
  105.           $comment .= "\n" . $line;
  106.         }
  107.       }
  108.       $entry->comment = trim($comment);
  109.       $changes[$entry->commitid] = $entry;
  110.     }
  111.   }
  112.   return $changes;
  113. }
  114.  
  115. function print_changes($changes) {
  116.   // Sort changes chronologically
  117.   usort($changes, 'log_date_cmp');
  118.   print "<ul>\n";
  119.   foreach ($changes as $k => $obj) {
  120.     print '<li>' . preg_replace('/#(\d+)/', '<a href="/node/$1">#$1</a>', $obj->comment) . "</li>\n";
  121.   }
  122.   print "</ul>\n";
  123. }
  124.  
  125. function cvs_explode($text, $delim = ':') {
  126.   $parts = explode($delim, $text, 2);
  127.   return trim($parts[1]);
  128. }
  129.  
  130. function log_date_cmp($a, $b) {
  131.   if ($a->date == $b->date) {
  132.     return 0;
  133.   }
  134.   return ($a->date < $b->date) ? -1 : 1;
  135. }