Modify roll_dep's commit message

roll_dep.py

 #!/usr/bin/env python
 # Copyright (c) 2014 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """This scripts takes the path to a dep and an svn revision, and updates the
 parent repo's DEPS file with the corresponding git revision.  Sample invocation:
 
 [chromium/src]$ roll-dep third_party/WebKit 12345
 
 After the script completes, the DEPS file will be dirty with the new revision.
 The user can then:
 
 $ git add DEPS
 $ git commit
 """
 
 import ast
 import os
 import re
 import sys
 
 from itertools import izip
 from subprocess import Popen, PIPE
 from textwrap import dedent
 
 
 SHA1_RE = re.compile('^[a-fA-F0-9]{40}$')
 GIT_SVN_ID_RE = re.compile('^git-svn-id: .*@([0-9]+) .*$')
+ROLL_DESCRIPTION_STR = '''Roll %s from %s to %s
+
+Summary of changes available at: %s

[szager1, 2014/08/28 21:24:51]

Let's move the link to another line, to hopefully prevent overflow:

Summary of changes available at:
    %s

[borenet, 2014/08/29 13:32:02]

Done.

+'''
 
 
 def posix_path(path):
   """Convert a possibly-Windows path to a posix-style path."""
   (_, path) = os.path.splitdrive(path)
   return path.replace(os.sep, '/')
 
 
 def platform_path(path):
   """Convert a path to the native path format of the host OS."""
@@ skipping 201 matching lines @@
       'Could not find definition of "%s" var in DEPS file.' % var_name)
   val_node = vars_node.values[var_idx]
   return update_node(deps_lines, deps_ast, val_node, git_revision)
 
 
 def generate_commit_message(deps_section, dep_name, new_rev):
   (url, _, old_rev) = deps_section[dep_name].partition('@')
   if url.endswith('.git'):
     url = url[:-4]
   url += '/+log/%s..%s' % (old_rev[:12], new_rev[:12])
-  return dedent('''\
-      Rolled %s
-          from revision %s
-          to revision %s
-      Summary of changes available at:
-          %s\n''' % (dep_name, old_rev, new_rev, url))
+  return dedent(ROLL_DESCRIPTION_STR % (
+      dep_name, old_rev[:12], new_rev[:12], url))

[szager1, 2014/08/28 21:23:15]

Can we use ellipses for over-long dep names?  Something like:

while len(dep_name) > 40:
  dep_name = '.../' + dep_name.lstrip('./').partition('/')[2]

[borenet, 2014/08/29 13:32:02]

Done.  Added a helper function since my intention is to have the AutoRoll Bot
import this file and use the ROLL_DESCRIPTION_STR directly when searching for
in-progress rolls.  Here's an example commit message where the dep_name was
shortened:

"""
Roll .../WebKit/LayoutTests/w3c/csswg-test from 0b12ea22689e to 198f08fb5364

Summary of changes available at:
   
https://chromium.googlesource.com/external/w3c/csswg-test/+log/0b12ea22689e.....
"""

The title line is under 80 chars, but the log link overflows.

 
 def update_deps_entry(deps_lines, deps_ast, value_node, new_rev, comment):
   line_idx = update_node(deps_lines, deps_ast, value_node, new_rev)
   (content, _, _) = deps_lines[line_idx].partition('#')
   if comment:
     deps_lines[line_idx] = '%s # %s' % (content.rstrip(), comment)
   else:
     deps_lines[line_idx] = content.rstrip()
 
 def update_deps(soln_path, dep_name, new_rev, comment):
@@ skipping 53 matching lines @@
   soln = get_solution(gclient_root, dep_path)
   soln_path = os.path.relpath(os.path.join(gclient_root, soln['name']))
   dep_name = posix_path(os.path.relpath(dep_path, gclient_root))
   (git_rev, svn_rev) = get_git_revision(dep_path, revision)
   comment = ('from svn revision %s' % svn_rev) if svn_rev else None
   assert git_rev, 'Could not find git revision matching %s.' % revision
   return update_deps(soln_path, dep_name, git_rev, comment)
 
 if __name__ == '__main__':
   sys.exit(main(sys.argv[1:]))